Transcription

1 Using NetAdvantage 2005 Volume 2 elements in Windows Sharepoint Services Web Parts Microsoft Windows Sharepoint Services (WSS) is a powerful web-based portal package that many companies have adopted as a means of communication and collaboration in their organization. WSS works by presenting users a series of Web Parts organized into a single web page. Web Parts deliver the necessary information to end users, and allow them to create customized interfaces containing the key information unique to each user. Web Parts are also a key feature of WSS easy to use extensibility model. This model gives developers the power to create their own custom Web Parts using ASP.NET and plug them directly into the WSS framework. Developers can utilize the power of the NetAdvantage ASP.NET elements to create highly customized, and powerful custom Web Parts for their WSS based collaboration portals. This article shows you how you can create a simple Web Part that contains elements from the NetAdvantage 2005 Volume 2 toolset, and then deploy the Web Part to a WSS server. Creating a Simple Web Part Creating custom Web Parts for WSS is a simple task, consisting of two basic steps: creating a Web Part Library in Visual Studio.NET, and deploying the library to your WSS server. Before starting to create your first Web Part, it is recommended that you download and install the Sharepoint Web Part Templates for Visual Studio.NET. These Visual Studio project templates greatly simply creating Web Parts by providing you with a complete stub class from which you can start creating your custom Web Part. In addition to installing the Templates, before you get started with this articles sample, it is recommended that you read and understand the Creating a Basic Web Part topic on the MSDN website. In this article, you will see how to build a simple Web Part that adds several different server controls, including a TextBox, Button, Calendar and UltraWebTree control to the Web Part. The UltraWebTree will be populated with several sample nodes. To get started, simply select the Web Part Library from Visual Studio. This project template includes a stub Web Part class, as well as the DWP file used to load the Web Part into Sharepoint.

2 The following code listing demonstrates how to create the sample Web Part. VB Imports System Imports System.ComponentModel Imports System.Web.UI Imports System.Web.UI.WebControls Imports System.Xml.Serialization Imports Microsoft.SharePoint Imports Microsoft.SharePoint.Utilities Imports Microsoft.SharePoint.WebPartPages Description for WebPart1. <DefaultProperty("Text"), _ ToolboxData("<0:WebPart1 runat=server></0:webpart1>"), _ XmlRoot(Namespace:="WebPartLibrary2")> _ Public Class WebPart1 Inherits Microsoft.SharePoint.WebPartPages.WebPart Private Const _defaulttext As String = "" Private table As Table Private webtree As Infragistics.WebUI.UltraWebNavigator.UltraWebTree Private textbox As TextBox Private button As Button Private calendar As Calendar Dim _text As String = _defaulttext <Browsable(True), Category("Miscellaneous"), _ DefaultValue(_defaultText), WebPartStorage(Storage.Personal), _ FriendlyName("Text"), Description("Text Property")> _ Property [Text]() As String Get Return _text End Get Set(ByVal Value As String) _text = Value End Set End Property Render this Web Part to the output parameter specified. Protected Overrides Sub RenderWebPart( _ ByVal output As System.Web.UI.HtmlTextWriter)

3 Try output.write(spencode.htmlencode(text)) Render the individual controls being added to the Web Form table.rendercontrol(output) Catch exc As Exception output.write(exc.message + exc.source + exc.stacktrace) End Try End Sub Protected Overrides Sub CreateChildControls() MyBase.CreateChildControls() table = New Table table.gridlines = GridLines.Both table.borderwidth = Unit.Pixel(0) table.width = Unit.Percentage(100) table.height = Unit.Percentage(100) table.rows.add(new TableRow) table.rows.add(new TableRow) table.rows(0).cells.add(new TableCell) table.rows(0).cells.add(new TableCell) table.rows(1).cells.add(new TableCell) table.rows(1).cells.add(new TableCell) Add a WebTree to the Controls collection webtree = New Infragistics.WebUI.UltraWebNavigator.UltraWebTree webtree.id = "UltraWebTree1" webtree.expandimage = "ig_treeplus.gif" webtree.collapseimage = "ig_treeminus.gif" table.rows(0).cells(0).width = Unit.Pixel(120) table.rows(0).cells(0).verticalalign = VerticalAlign.Top table.rows(0).cells(0).controls.add(webtree) Add a TextBox to the Controls collection textbox = New TextBox textbox.id = "TextBox1" table.rows(1).cells(1).controls.add(textbox) Add a Button to the Controls collection button = New Button button.id = "Button1"

4 button.text = "Submit" table.rows(1).cells(1).controls.add(button) Add a Calendar to the Controls collection calendar = New Calendar calendar.id = "Calendar1" calendar.selecteddate = System.DateTime.Now table.rows(0).cells(1).controls.add(calendar) If (Not Page.IsPostBack) Then Add several tree nodes to the WebTree You could also create the nodes by binding the tree to a data source, or by enumerating a collection and recursivly adding nodes Dim node As Infragistics.WebUI.UltraWebNavigator.Node node = webtree.nodes.add("root1") node.nodes.add("child1") node = webtree.nodes.add("root2") node.nodes.add("child2") node = webtree.nodes.add("root3") node.nodes.add("child3") node = webtree.nodes.add("root4") node.nodes.add("child4") End If Controls.Add(table) End Sub End Class

5 C# using System; using System.ComponentModel; using System.Web.UI; using System.Web.UI.WebControls; using System.Xml.Serialization; using Microsoft.SharePoint; using Microsoft.SharePoint.Utilities; using Microsoft.SharePoint.WebPartPages; namespace WebPartLibrary1 /// <summary> /// Description for WebPart1. /// </summary> [DefaultProperty("Text"), ToolboxData("<0:WebPart1 runat=server></0:webpart1>"), XmlRoot(Namespace="WebPartLibrary1")] public class WebPart1 : Microsoft.SharePoint.WebPartPages.WebPart private const string defaulttext = ""; private Table table; private Infragistics.WebUI.UltraWebNavigator.UltraWebTree webtree; private TextBox textbox; private Button button; private Calendar calendar; private string text = defaulttext; [Browsable(true), Category("Miscellaneous"), DefaultValue(defaultText), WebPartStorage(Storage.Personal), FriendlyName("Text"), Description("Text Property")] public string Text get return text; set text = value;

6 /// <summary> /// Render this Web Part to the output parameter specified. /// </summary> /// <param name="output"> The HTML writer to write out to </param> protected override void RenderWebPart(HtmlTextWriter output) try output.write(spencode.htmlencode(text)); //Render the individual controls being added to the Web Form table.rendercontrol(output); catch (Exception exc) output.write(exc.message); /// <summary> /// /// </summary> protected override void CreateChildControls() base.createchildcontrols (); table = new Table(); table.gridlines=gridlines.both; table.borderwidth=unit.pixel(0); table.width=unit.percentage(100); table.height=unit.percentage(100); table.rows.add(new TableRow()); table.rows.add(new TableRow()); table.rows[0].cells.add(new TableCell()); table.rows[0].cells.add(new TableCell()); table.rows[1].cells.add(new TableCell()); table.rows[1].cells.add(new TableCell()); //Add a WebTree to the Controls collection webtree=new Infragistics.WebUI.UltraWebNavigator.UltraWebTree(); webtree.id="ultrawebtree1"; webtree.expandimage="ig_treeplus.gif"; webtree.collapseimage="ig_treeminus.gif"; table.rows[0].cells[0].width=unit.pixel(120);

7 table.rows[0].cells[0].verticalalign=verticalalign.top; table.rows[0].cells[0].controls.add(webtree); //Add a TextBox to the Controls collection textbox=new TextBox(); textbox.id="textbox1"; table.rows[1].cells[1].controls.add(textbox); //Add a Button to the Controls collection button=new Button(); button.id="button1"; button.text="submit"; table.rows[1].cells[1].controls.add(button); //Add a Calendar to the Controls collection calendar=new Calendar(); calendar.id="calendar1"; calendar.selecteddate=system.datetime.now; table.rows[0].cells[1].controls.add(calendar); if (!Page.IsPostBack) //Add several tree nodes to the WebTree //You could also create the nodes by binding // the tree to a data source, or by enumerating // a collection and recursivly adding nodes Infragistics.WebUI.UltraWebNavigator.Node node; node=webtree.nodes.add("root1"); node.nodes.add("child1"); node=webtree.nodes.add("root2"); node.nodes.add("child2"); node=webtree.nodes.add("root3"); node.nodes.add("child3"); node=webtree.nodes.add("root4"); node.nodes.add("child4"); Controls.Add(table);

8 Once you enter the code for the Web Part you need to create a Strong Name Key for the assembly. WSS requires that all Web Part assemblies it hosts be strongly named. To create a key for your Web Part assembly, simply use the command line sn.exe utility included with the.net SDK. sn -k c:\keypair.snk Once you have created the key, you need to modify the AssemblyKeyFile attribute found in the AssemblyInfo.cs file included in your Web Part Library project. [assembly: AssemblyKeyFile("c:\\keypair.snk")] Once this attribute has been modified, the next time you build the web Part Library project, the resulting assembly will contain a strong name, allowing you to deploy it to Sharepoint. Configuring Sharepoint 2003 Once you have completed creating your WSS Web Part assembly, you need to configure your WSS server so that the assembly can be deployed and executed properly. There are several different configuration file changes that you will need to make, as well as configuring Sharepoint so that the client side JavaScript and image files used by the NetAdvantage elements can be accessed properly. Deploying and configuring NetAdvantage resources Because the sample Web Part created in the prior section utilizes an element from the NetAdvantage toolset (the UltraWebTree), the first step in deploying your Web Part is to configure the client script files and images used by the NetAdvantage elements. To do this, you simply need to copy the required script and image files to the WSS server. Once that is completed you will create a new virtual directory in IIS and configure the Virtual Directory in Sharepoint. Using the NetAdvantage Installation to Configure Scripts and Images The easiest way to ensure that these files are configured properly is to simply run the NetAdvantage installation on the Sharepoint Services server. If you choose to do this, it is recommended that you select the custom installation option and remove the Help and Samples options from the installation. Manual Installation of NetAdvantage Scripts and Images Should you decided to deploy the files to your WSS server manually, you simply need to create a location within IIS that contains the necessary scripts and images that the NetAdvantage controls can access. There are two ways to do this.

9 1. Create a folder called ig_common in your web root (usually c:\inetpub\wwwroot\). 2. Create a Virtual Directory in the root of IIS called ig_common. Creating a Virtual Directory allows you to place the script and images files anywhere on your server. IIS can contain several different WSS related websites, each containing several different web.config files, so you need to make sure you are editing the proper file. The web.config file you want to edit is located under the root of the IIS site that contains your WSS virtual server site. You do not want to edit the web.config files in the Sharepoint Central Administration site.

10 Once you have created the ig_common directory (or Virtual Directory), locate the c:\inetpub\wwwroot\aspnet_client\infragistics directory on your development system. Installed by the NetAdvantage installation program, this folder contains the image and script files needed by the NetAdvantage ASP.NET elements. Exploring the directory, you will find a single Images directory, as well as a separate directory containing the JavaScript files for every version of NetAdvantage you have installed. The script folder names follow the pattern YYYYR, a four digit year combined with a release number (i.e 20053) To deploy the resources, simply copy the Images directory and the appropriate script version directory from your development system to the ig_common directory on your WSS server. For example, if you are currently using NetAdvantage 2005 Volume 2, then you would copy the Images directory and the directory. Configuring an Excluded Directory Finally you need to configure the ig_common directory (or Virtual Directory) as an Excluded Directory in Sharepoint. By default, Sharepoint will try to take over every incoming web request, including requests to the ig_common directory. Configuring the directory as an Excluded directory, prevents Sharepoint from intercepting requests made to it. 1. On the server that is running Sharepoint Services, click Start, click Administrative Tools, then click Sharepoint Central Administration 2. In the Virtual Server Configuration area, click Configure virtual server settings 3. Form the Virtual Server List, click the link of the virtual server that you want to add the excluded paths to 4. Under Virtual Server Management, click Define Managed Paths 5. In the Add a New Path section, type the path to exclude in the Path box 6. Click the Exclude path option 7. Click the OK button at the bottom of the page When you have completes the steps, the newly added excluded path will be displayed in the Excluded Paths list

11 Deploying the Web Part Assemblies Once you have completed deploying the required NetAdvantage assets, you can now deploy your web parts main and referenced assemblies. To do this simply copy the Web Parts main assembly and all referenced NetAdvantage assemblies to the Bin directory of your Sharepoint Services Virtual Server. If no Bin directory exists in your virtual server simply create one. Configuring Web Part Assembly Security By default WSS uses a very low level of trust for.net assemblies. In order to complete the deployment of your sample Web Part, you need to configure WSS so that it will consider the Web Parts assembly as safe, and then grant the assembly a higher level of trust. These configuration changes are made in the web.config file locate in the WSS virtual server root. IIS generally contains several different WSS related websites, each containing several different web.config files, so you need to make sure you are editing the proper file. The web.config file you want to edit is located under the root of the IIS site that contains your WSS virtual server site. You do not want to edit the web.config files in the Sharepoint Central Administration site. Declaring your assembly a SafeControl In order to execute the Web Part assembly, WSS requires that you register it and its namespace as a SafeControl in the web.config file. To do this, simple add a new <SafeControl> block to the web.config. <SafeControl Assembly="WebPartLibrary1, Version= , Culture=neutral, PublicKeyToken=def148956c61a16b" Namespace="WebPartLibrary1" TypeName="*" Safe="True" /> Replace the PublicKeyToken value (def148956c61a16b) in the above sample with the actual value for your Web Part's assembly. To determine the correct PublicKeyToken value for the Assembly attribute of the <SafeControl> tag for your Web Part, use the sn.exe command-line utility: sn.exe -T c:\inetpub\wwwroot\bin\webpartlibrary1.dll

12 Setting the Assembly Trust level Locate or add the <trust> node in the web config file and change the level attribute to Full. WSS uses the.net Frameworks built in Code Access Security (CAS) model to determine the trust level of your web parts assembly, and what access rights it should have. By changing the Trust mode of your WSS to Full, you are explicitly granting any web part you add full CAS trust. <trust level="full" originurl="" />. Should you not want to change the trust level of your entire virtual server to Full, there are other ways of configuring web part security. First, you can create a policy for your web parts assembly specifying the CAS rights required to execute the assembly. Second you can install your web part assembly into the Global Assembly Cache (GAC). Installing an assembly into the GAC automatically grants the assembly full trust. For more information on this topic, please refer to the article Microsoft Windows Sharepoint Services and Code Access Security, on the Microsoft MSDN website. Using the Web Part in Sharepoint Once you have completed configuring Sharepoint and deploying your web part, you simply need to add the Web Part to the Web Part Gallery in your Sharepoint site. To do this, open the Modify Shared Page menu and select Add Web Parts > Import. This will display an Import web form that allows you to upload a web part definition to the Web Parts Gallery. Your web part definition file is the DWP file that was created as part of the Visual Studio Web Part Library project template. To add the definition, click the Browse button and locate and select the WebPart1.dwp file that was created as part of your project template. Once you have selected the file, simply click the Upload button on the web forms to upload the definition into the Web Parts Gallery. The newly uploaded web part will be displayed below the form Import form. Now that you have added the Web Part to the Gallery, you can simply drag the web part into one of the Sharepoint content areas, as shown on the right. Once you drop the web part into the content area, it will begin to render.

13 Conclusion This whitepaper has demonstrated how you can use tools from the NetAdvantage 2005 Volume 2 toolkit within custom Windows Sharepoint Services web parts. Completing these simple steps, including proper server configuration and deployment allow you to create rich web parts using the powerful tools contained in the NetAdvantage toolkit.