Share Point 2007 Web Parts
This document was uploaded by user and they confirmed that they have the permission to share it. If you are author or own the copyright of this book, please report to us by using this DMCA report form. Report DMCA
Overview
Download & View Share Point 2007 Web Parts as PDF for free.
More details
- Words: 9,855
- Pages: 47
Page 1 of 47 Getting started with SharePoint 2007 Web Parts By Gavin Sinai Four important aspects of SharePoint 2007 Web Part development
Introduction Writing SharePoint Web Parts is one of the best ways to customize the SharePoint platform. Web Parts combine the power of ASP.NET with the flexibility of Web Part Pages. This article is intended to help you get going quickly with Web Part development. We briefly cover four topics in Web Part development: • Setting up the Visual Studio SharePoint development environment. • Creating and rendering ASP.NET controls in Web Parts • Accessing SharePoint data using the Microsoft.SharePoint namespace • Using the settings API so that admin users can configure and manage web parts in production. Background Knowledge of SharePoint, ASP.NET and Visual Studio is required. Creating the Visual Studio SharePoint development environment In this section the steps to setup your development are covered. If you already have a working dev environment then you can safely skip this section. In order to follow these steps you will need Visual Studio 2005 (.NET 2.0) or later. You will also need network access to a Windows 2003/8 server with SharePoint 2007 (WSS or MOSS) - SharePoint does not run on XP or Vista. I usually use a Windows 2003 Virtual PC with .NET 3.5 and Windows SharePoint Services 3.0. One can also install Visual Studio 2005/8 on the development server. We assume you have administration rights on your SharePoint server and also administration rights in your target SharePoint web application. The steps to setting up your Visual Studio Web Part development environment are as follows: 1. In Visual Studio, create a new class library
Page 1 of 47
Page 2 of 47 2. Add a reference to System.Web
3. In this step we create a simple Web Part that prints "Hello World!" to the screen. A Web Part is a class that inherits from the WebPart class in System.Web.UI.WebControls.WebParts. In order to control the rendering of the Web Part one overrides the Render method. An HtmlTextWriter instance is passed into the Render method and can then be used to write markup to the page output. The code below is an example of this: 4. using System; 5. using System.Collections.Generic; 6. using System.Text; 7. 8. using System.Web; 9. using System.Web.UI; 10.using System.Web.UI.WebControls; 11.using System.Web.UI.WebControls.WebParts; 12. 13.namespace ExampleWebPartLibrary 14. { 15. public class MyWebPart : WebPart 16. { 17. 18. protected override void Render(HtmlTextWriter writer) 19. { 20. writer.Write("Hello World!"); 21. } 22. 23. } } 24.Using Visual Studio or another suitable tool, give your class library a strong name key and get the full name of your assembly. You can get the fullname by using "gacutil /l" in the Visual Studio Command Prompt or by using Lutz Roeder's .NET reflector. 25.In your class library properties, set the build output path to the bin directory of your SharePoint development web application. I usually share the directory on my development server as "\\SharePointDev\wss_bin" and use this directory as my build output directory. In Windows SharePoint Services 3.0 the bin directory is usually of the form "C:\Inetpub\wwwroot\wss\VirtualDirectories\[Port Num]\bin" and I share this directory as "wss_bin". Page 2 of 47
Page 3 of 47
26.Add the code statements using System.Security; and [assembly: AllowPartiallyTrustedCallers] to your AssemblyInfo.cs file. 27. Ensure that your class library builds and that Visual Studio places the DLL in the expected location on the server 28.In the web.config file on your target server, you need to add the assembly as a safe control. You can copy one of the existing safe control entries and fill that in with the details of your assembly. You will need the full name of the assembly to complete this step. 29.<SafeControl 30. Assembly="ExampleWebPartLibrary, Version=1.0.0.0, Culture=neutral, PublicKeyToken=db485f68ad2dc0c5" 31. Namespace="ExampleWebPartLibrary" TypeName="*" Safe="True" AllowRemoteDesigner="True" /> 32.You can now add the web part library to your SharePoint site. To do this, log in as an administrator and go to the settings page. Click on "Web Part Gallery" under the "Galleries" section. Click "New" and you should see your web part in a list. Select your web part and click "populate gallery".
33. You can give your web part a friendly title and control its permissions using the edit button in the web part gallery. I have chosen to call the Web Part "My Web Part". Page 3 of 47
Page 4 of 47 34. Finally you can add the web part to a web part page and you should see the web part's hard coded "Hello World!" message. If your build target is set to the SharePoint bin directory as per step 5 in the list above, then you won't have to redeploy when you want to test changes. Each time the class library is rebuilt, you can test the latest version of your Web Part by refreshing your Web Part page. You also do not need to repeat the above steps whenever you add a new web part to the library. Each time you add a new web part to the library you simply need to "Populate Gallery" with your new web part. Remote debugging can be used to debug the Web Part. We won't go into that here; the MSDN library has an article about this. Using ASP.NET controls in your web part In Web Part development you don't have the luxury of Visual Studio's code generation for ASP.NET. You have to declare, initialise, configure and render the controls yourself in the correct phases of the Web Part life cycle. In this example we will create a button and a label and use the button press event to change the label text. Controls should be declared as member variables and then initialised and configured within an override of the CreateChildControls method. I usually create a separate method to setup each control and then invoke that method from CreateChildControls. It is important to add the created controls to the list of Web Part controls. If a control is not added to this list then it's events won't be raised on post back. private Button btnDemo; private void createBtnDemo() { btnDemo = new Button(); btnDemo.Text = "Click me"; btnDemo.Click += new EventHandler(btnDemo_Click); // This line of code is required to trigger the click event Controls.Add(btnDemo); } protected override void CreateChildControls() { base.CreateChildControls(); createBtnDemo(); createLblHelloWorld(); } The controls are rendered inside the Render method override. This method can be used to layout the web part it's controls. The HtmlTextWriter has many useful methods to help out, including WriteBreak() which writes a "
". protected override void Render(HtmlTextWriter writer) { writer.WriteBreak(); lblHelloWorld.RenderControl(writer); writer.WriteBreak(); writer.WriteBreak(); btnDemo.RenderControl(writer); } Note: A known work around to the problem of not having Visual Studio support for Web Part development is to embed UserControls in the Web Part. You can read about that in this Code Project article. Page 4 of 47
Page 5 of 47 Accessing SharePoint data in your web part There are two steps you need to take in order to access SharePoint data from within your web part. The first is to reference Microsoft.SharePoint.dll. You can get a copy of this DLL from your SharePoint server by browsing to the directory "[Program Files]\Common Files\Microsoft Shared\web server extensions\12\ISAPI". The second step is to take care of the code access security for your web part. The easiest way of doing this is to set the target SharePoint site's trust level to "Full". This level of trust is generally acceptable in an Intranet environment. If you require that the SharePoint site be run in a minimal or medium trust level environment then you will need to configure your code access security manually. To take the easy way out and set the site trust level to "Full" find the following in your site's web.config file: <trust level="WSS_Minimal" originUrl="" /> Now change this to: <trust level="Full" originUrl="" /> Now you can write some code to access SharePoint data. This is just a question of learning and understanding the SharePoint API, which is worthy of several articles in its own right. Here I show a simple web part that displays the name of the presently logged in user: using System.Web.UI.WebControls.WebParts; using Microsoft.SharePoint; namespace ExampleWebPartLibrary { public class HelloUser : WebPart { protected override void Render(System.Web.UI.HtmlTextWriter writer) { // Get a contextual reference to the current SPWeb SPWeb currentWeb = SPContext.Current.Web; // Write a message to the current user writer.Write("Hello " + currentWeb.CurrentUser.LoginName); } } } SPContext.Current.Web is the starting point for accessing SharePoint data. For example you can use it to access data in lists and document libraries. Using SharePoint settings to manage your Web Part
Web Parts will invariably need settings in order to be useful. There are two ways of providing your web parts with settings in run time. In a bespoke environment it may be acceptable to place the settings in the web.config and access them in the same way as you would for standard ASP.NET applications. However if you require that users be able to easily configure and manage the web part themselves, then you need to Page 5 of 47
Page 6 of 47 use the SharePoint API to give the web part settings. This will almost certainly be the case if you are an Independent Software Vendor making a packaged release of your Web Part. Fortunately it's quite easy to settings-enable your web part. The following steps assume you are starting with an existing web part, but you can skip to the listing at the end of the article if you are starting from scratch. 1. Add the required using statements 2. using System; 3. 4. using System.ComponentModel; 5. using System.Runtime.InteropServices; 6. using System.Xml.Serialization; 7. 8. using Microsoft.SharePoint; using Microsoft.SharePoint.WebPartPages; 9. Change your web part to inherit from the Microsoft.SharePoint.WebPartPages.WebPart 10.Create a new guid for your web part. Add the Guid and XmlRoot attributes to your Web Part as follows: 11.[Guid("692b5ada-2f4c-45b0-b9a5-e718db958ae6")] 12.[XmlRoot(Namespace = "ExampleWebPartLibrarySettingsDemo")] public class SettingsDemo : Microsoft.SharePoint.WebPartPages.WebPart 13. Add the different attributes applied to the property that is used as a setting. Adjust the constant string attribute arguments according to your needs. 14.private string mySetting; 15. 16. // SharePoint setting with required attributes 17.[Browsable(true), 18.Category("Example Web Parts"), 19.DefaultValue("Default"), 20.WebPartStorage(Storage.Shared), 21.FriendlyName("MySetting"), 22.Description("An example setting")] 23.public string MySetting 24. { 25. get { return mySetting; } 26. set { mySetting = value; } } 27. Using the setting in code (in this case, the render method). The complete code listing is as follows: // using statements required for settings using System; using System.ComponentModel; using System.Runtime.InteropServices; using System.Xml.Serialization; using Microsoft.SharePoint; using Microsoft.SharePoint.WebPartPages; namespace ExampleWebPartLibrary { //Guid and XmlRoot attributes for a settings enabled web part [Guid("692b5ada-2f4c-45b0-b9a5-e718db958ae6")] Page 6 of 47
Page 7 of 47 [XmlRoot(Namespace = "ExampleWebPartLibrarySettingsDemo")] // NB inherit from SharePoint WebPart rather than ASP.NET Web Part public class SettingsDemo : Microsoft.SharePoint.WebPartPages.WebPart { private string mySetting; // SharePoint setting with required attributes [Browsable(true), Category("Example Web Parts"), DefaultValue("Default"), WebPartStorage(Storage.Shared), FriendlyName("MySetting"), Description("An example setting")] public string MySetting { get { return mySetting; } set { mySetting = value; } } // use the setting in code protected override void Render(System.Web.UI.HtmlTextWriter writer) { writer.Write("Value of MySetting: "); writer.Write(mySetting); } } }
SharePoint 2007 Flash Animation Web Part By Mahdi Abdulhamid
Page 7 of 47
Page 8 of 47
Introduction I've seen that many people are using HTML content web part for displaying Flash animation. I don't recommend this approach for many reasons, one of them being you won't tell your client to edit HTML code for changing Flash properties; so it is better to have a dedicated web part for rendering Flash animation. Software Requirements • Microsoft SharePoint 2007 installed (With Site Collection created on port:80) • SharePoint Services 3.0 Extensions for Visual Studio 2005 installed Using the code To apply the code, you will need to create a new SharePoint Webpart Project then overrides the web part class file: using System; using System.ComponentModel; using System.Runtime.InteropServices; using System.Web.UI; using System.Web.UI.WebControls.WebParts; using System.Web.UI.WebControls; using System.Xml.Serialization; using Microsoft.SharePoint; using Microsoft.SharePoint.WebControls; using Microsoft.SharePoint.WebPartPages; using Microsoft.SharePoint.Utilities; using System.Web.UI.HtmlControls; namespace FlashWebPart { [Guid("f04fa49d-1342-4c7d-904a-c43ebc942f39")] [XmlRoot(Namespace = "FlashWebPart")] public class FlashWebPart : Microsoft.SharePoint.WebPartPages.WebPart { public FlashWebPart() { this.ExportMode = WebPartExportMode.All; } protected int flashWidth = 400; protected int flashHeight = 300; Page 8 of 47
Page 9 of 47 protected string flashUrl = ""; public int FlashWidth { get { return this.flashWidth; } set { this.flashWidth = value; } } public int FlashHeight { get { return this.flashHeight; } set { this.flashHeight = value; } } public string FlashURL { get { return this.flashUrl; } set { this.flashUrl = value; } } Page 9 of 47
Page 10 of 47 protected override void Render(HtmlTextWriter writer) { string outHTML = ""; writer.Write(outHTML); } } }
/w EPDw UKMTAy
Simple WebPart To Load UserControl By agusto xaverius It is a simple webpart but very usefull to load many usercontrols
Introduction Moss/WSS is so CMS popular currently. There are many thing can be which can be done and is modified at deep technology on that product. Work with on that solution will ever be utilize webpart. But if we develop one webpart sometimes we do ever make same old things which is make coding webpart and load the usercontrol what does we want. Background Page 10 of 47
Page 11 of 47 This concept is similiar with SmartPart which you just create one webpart and then it can be used to load all your usercontrol without writing webpart again. Using the Code The listing code is like this: 1. Write on your class solution like this. Please reference Microsoft.Sharepoint.dll component and System.Web.dll too. using System; using System.ComponentModel; using System.Text; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.WebControls.WebParts; using System.Xml.Serialization; using Microsoft.SharePoint; using Microsoft.SharePoint.Utilities; using Microsoft.SharePoint.WebPartPages; namespace WebPartLib { public class WebPartGeneral : Microsoft.SharePoint.WebPartPages.WebPart { private Control _childControl = null; private string _userControlVirtualPath = string.Empty; private string _errMessage = string.Empty; public WebPartGeneral() {} [ Personalizable(), Category("Miscellaneous"), DefaultValue(""), WebBrowsable(true), WebDisplayName("User Control Virtual Path"), WebDescription("User Control Virtual Path") ] public string UserControlVirtualPath { get { return _userControlVirtualPath; } set { _userControlVirtualPath = value; } } protected override void RenderWebPart(HtmlTextWriter output) { if (_errMessage != string.Empty) output.Write(_errMessage); if (_userControlVirtualPath != string.Empty || _userControlVirtualPath.Equals("") == false) RenderChildren(output); } protected override void RenderChildren(HtmlTextWriter output) { try Page 11 of 47
Page 12 of 47 { this.EnsureChildControls(); if (this._childControl != null) this._childControl.RenderControl(output); } catch (Exception ex) { _errMessage = string.Format( "Exception Message (RenderWebPart) = {0}
", ex.Message); } } protected override void CreateChildControls() { base.CreateChildControls(); if (_userControlVirtualPath != string.Empty) { if (_childControl != null) return; _childControl = Page.LoadControl(_userControlVirtualPath); if (_childControl != null) Controls.AddAt(0, _childControl); } } public override void Dispose() { } } } 2. After the solution already successfully compile and the put the binary into bin folder on your MOss/Wss site. After it also make one folder by which UserControls. 1. Modify your web.config eControl Assembly="WebPartLib, Version=1.0.0.0, Culture=neutral" Namespace="WebPartLib" TypeName="*" Safe="True" AllowRemoteDesigner="True" /> and change trust level from WSS_Minimal into Full. <trust level="Full" originUrl="" /> 4. If Necesary you can client restart your IIS and the back to your site again and list the webpart into list of webpart 5. Create new website solution and create a simple usercontrol and then copy all .ascx and .cs into UserControls folder 6. Now you can utilize webpart and set the virtual path into your usercontrols and the simsalabim your webpart now load your usercontrol. You can create another usercontrol again and you can add your webpart again and set the usercontrols to load.
Page 12 of 47
Page 13 of 47
WebPart Life CycleBy Fabio Barbieri This article examines the production of a simple WebPart in C# Page 13 of 47
Page 14 of 47
Introduction In Sharepoint 2007, a way to customize the environment pass is by building WebParts coded with one of the languages available in VS2005. In this article, we're going to examine the production of a simple WebPart in C#, to better comprehend the life cycle and later, look at events that the developer has to consider in order to get the correct execution of code. Use Case Description In this sample will be proposed a typical case where the selection of an item in a dropdown list raises the event of filling a second dropdown list (server-side event) with proper items to the value selected. Specifically, the first dropdown list contains a short nations list, the second dropdown list will be loaded with a short town list belonging to the nation selected. Besides the two dropdown lists are shown the steps regarding principal event routines and property Text of DropDownList nation. The complete Webpart will have the following rendering graphic:
The Web Part It is interesting to note that DropDownList nation has set ViewState and AutoPostBack to true. The article scope is to highlight the WebPart life Cycle and understand when the value of a control (i.e. Text property) that has ViewState set up to be true, becomes available. In practice, this happens when the user selects a nation changing the first dropdown list item which starts the Postback event, at which point the value of the new item is available. The Code As is possible to understand by the shown log, there are four predefined routines that take place in a WebPart Life Cycle: 1. OnInit: Typically in this routine we define controls that will be involved with WebPart: 2. protected override void OnInit(EventArgs e) 3. { 4. try 5. { 6. _divPanel = new Panel(); Page 14 of 47
Page 15 of 47 7. 8.
_ddlCountry = new DropDownList();
_ddlTown = new DropDownList(); 9. CreateChildControls: In this routine are defined control properties and methods previously declared. In most cases, we have to initialize the control's default value (as Text, Checked, Items, and so on) and activity that is possible to call just at first WebPart load, checking PostBack: 10.protected override void CreateChildControls() 11. { 12. try 13. { 14. base.CreateChildControls(); 15. _divPanel.ID = "_divPanel"; 16. _divPanel.BorderStyle = BorderStyle.Ridge; 17. _divPanel.Width = 250; 18. _divPanel.Height = 300; 19. _divPanel.BackColor = System.Drawing.Color.Gainsboro; 20. Controls.Add(_divPanel); 21. _ddlCountry.AutoPostBack = true; 22. _ddlCountry.ID = "_ddlCountry"; 23. _ddlCountry.Width = 150; 24. _ddlCountry.EnableViewState = true; 25. _ddlCountry.SelectedIndexChanged += 26. new EventHandler(_ddlCountry_SelectedIndexChanged); 27. _divPanel.Controls.Add(_ddlCountry); 28. _ddlTown.AutoPostBack = false; 29. _ddlTown.ID = "_ddlTown"; 30. _ddlTown.Width = 150; 31. _ddlTown.EnableViewState = true; 32. _divPanel.Controls.Add(_ddlTown); 33. 34. if (!Page.IsPostBack) ddlCountry_Load(); 35.OnPreRender: This is the routine where the control's value kept by ViewState (for example Item value set up by the user to DropDownList nation), is available. For this reason, it's normal to begin business procedure from here, and in our case we're going to load values for the second dropdown list (Town DropDownList) with the proper data: 36.protected override void OnPreRender(EventArgs e) 37. { 38. try 39. { 40. _sMex += "OnPreRender: " + _ddlCountry.Text + " "; 41. string sStateSelected = _ddlCountry.Text; 42. _ddlTown.Items.Clear(); 43. 44. switch (sStateSelected) 45. { 46. case "England": 47. ddlTown_Load("London", "Liverpool", "Bristol"); 48. break; 49. 50. case "Spain": Page 15 of 47
Page 16 of 47 51. 52. 53. 54. 55. 56. 57. 58. 59. 60.
ddlTown_Load("Madrid", "Barcelona", "Valencia"); break; case "Italy": ddlTown_Load("Rome", "Milan", "Florence"); break; default: ddlTown_Load("New York", "Tokio", "Paris"); break;
} 61.Render: That's the routine for HTML rendering WebPart: 62.protected override void Render(HtmlTextWriter writer) 63. { 64. _sMex += "Render: " + _ddlCountry.Text + "
"; 65. writer.Write("
Introduction Writing SharePoint Web Parts is one of the best ways to customize the SharePoint platform. Web Parts combine the power of ASP.NET with the flexibility of Web Part Pages. This article is intended to help you get going quickly with Web Part development. We briefly cover four topics in Web Part development: • Setting up the Visual Studio SharePoint development environment. • Creating and rendering ASP.NET controls in Web Parts • Accessing SharePoint data using the Microsoft.SharePoint namespace • Using the settings API so that admin users can configure and manage web parts in production. Background Knowledge of SharePoint, ASP.NET and Visual Studio is required. Creating the Visual Studio SharePoint development environment In this section the steps to setup your development are covered. If you already have a working dev environment then you can safely skip this section. In order to follow these steps you will need Visual Studio 2005 (.NET 2.0) or later. You will also need network access to a Windows 2003/8 server with SharePoint 2007 (WSS or MOSS) - SharePoint does not run on XP or Vista. I usually use a Windows 2003 Virtual PC with .NET 3.5 and Windows SharePoint Services 3.0. One can also install Visual Studio 2005/8 on the development server. We assume you have administration rights on your SharePoint server and also administration rights in your target SharePoint web application. The steps to setting up your Visual Studio Web Part development environment are as follows: 1. In Visual Studio, create a new class library
Page 1 of 47
Page 2 of 47 2. Add a reference to System.Web
3. In this step we create a simple Web Part that prints "Hello World!" to the screen. A Web Part is a class that inherits from the WebPart class in System.Web.UI.WebControls.WebParts. In order to control the rendering of the Web Part one overrides the Render method. An HtmlTextWriter instance is passed into the Render method and can then be used to write markup to the page output. The code below is an example of this: 4. using System; 5. using System.Collections.Generic; 6. using System.Text; 7. 8. using System.Web; 9. using System.Web.UI; 10.using System.Web.UI.WebControls; 11.using System.Web.UI.WebControls.WebParts; 12. 13.namespace ExampleWebPartLibrary 14. { 15. public class MyWebPart : WebPart 16. { 17. 18. protected override void Render(HtmlTextWriter writer) 19. { 20. writer.Write("Hello World!"); 21. } 22. 23. } } 24.Using Visual Studio or another suitable tool, give your class library a strong name key and get the full name of your assembly. You can get the fullname by using "gacutil /l" in the Visual Studio Command Prompt or by using Lutz Roeder's .NET reflector. 25.In your class library properties, set the build output path to the bin directory of your SharePoint development web application. I usually share the directory on my development server as "\\SharePointDev\wss_bin" and use this directory as my build output directory. In Windows SharePoint Services 3.0 the bin directory is usually of the form "C:\Inetpub\wwwroot\wss\VirtualDirectories\[Port Num]\bin" and I share this directory as "wss_bin". Page 2 of 47
Page 3 of 47
26.Add the code statements using System.Security; and [assembly: AllowPartiallyTrustedCallers] to your AssemblyInfo.cs file. 27. Ensure that your class library builds and that Visual Studio places the DLL in the expected location on the server 28.In the web.config file on your target server, you need to add the assembly as a safe control. You can copy one of the existing safe control entries and fill that in with the details of your assembly. You will need the full name of the assembly to complete this step. 29.<SafeControl 30. Assembly="ExampleWebPartLibrary, Version=1.0.0.0, Culture=neutral, PublicKeyToken=db485f68ad2dc0c5" 31. Namespace="ExampleWebPartLibrary" TypeName="*" Safe="True" AllowRemoteDesigner="True" /> 32.You can now add the web part library to your SharePoint site. To do this, log in as an administrator and go to the settings page. Click on "Web Part Gallery" under the "Galleries" section. Click "New" and you should see your web part in a list. Select your web part and click "populate gallery".
33. You can give your web part a friendly title and control its permissions using the edit button in the web part gallery. I have chosen to call the Web Part "My Web Part". Page 3 of 47
Page 4 of 47 34. Finally you can add the web part to a web part page and you should see the web part's hard coded "Hello World!" message. If your build target is set to the SharePoint bin directory as per step 5 in the list above, then you won't have to redeploy when you want to test changes. Each time the class library is rebuilt, you can test the latest version of your Web Part by refreshing your Web Part page. You also do not need to repeat the above steps whenever you add a new web part to the library. Each time you add a new web part to the library you simply need to "Populate Gallery" with your new web part. Remote debugging can be used to debug the Web Part. We won't go into that here; the MSDN library has an article about this. Using ASP.NET controls in your web part In Web Part development you don't have the luxury of Visual Studio's code generation for ASP.NET. You have to declare, initialise, configure and render the controls yourself in the correct phases of the Web Part life cycle. In this example we will create a button and a label and use the button press event to change the label text. Controls should be declared as member variables and then initialised and configured within an override of the CreateChildControls method. I usually create a separate method to setup each control and then invoke that method from CreateChildControls. It is important to add the created controls to the list of Web Part controls. If a control is not added to this list then it's events won't be raised on post back. private Button btnDemo; private void createBtnDemo() { btnDemo = new Button(); btnDemo.Text = "Click me"; btnDemo.Click += new EventHandler(btnDemo_Click); // This line of code is required to trigger the click event Controls.Add(btnDemo); } protected override void CreateChildControls() { base.CreateChildControls(); createBtnDemo(); createLblHelloWorld(); } The controls are rendered inside the Render method override. This method can be used to layout the web part it's controls. The HtmlTextWriter has many useful methods to help out, including WriteBreak() which writes a "
". protected override void Render(HtmlTextWriter writer) { writer.WriteBreak(); lblHelloWorld.RenderControl(writer); writer.WriteBreak(); writer.WriteBreak(); btnDemo.RenderControl(writer); } Note: A known work around to the problem of not having Visual Studio support for Web Part development is to embed UserControls in the Web Part. You can read about that in this Code Project article. Page 4 of 47
Page 5 of 47 Accessing SharePoint data in your web part There are two steps you need to take in order to access SharePoint data from within your web part. The first is to reference Microsoft.SharePoint.dll. You can get a copy of this DLL from your SharePoint server by browsing to the directory "[Program Files]\Common Files\Microsoft Shared\web server extensions\12\ISAPI". The second step is to take care of the code access security for your web part. The easiest way of doing this is to set the target SharePoint site's trust level to "Full". This level of trust is generally acceptable in an Intranet environment. If you require that the SharePoint site be run in a minimal or medium trust level environment then you will need to configure your code access security manually. To take the easy way out and set the site trust level to "Full" find the following in your site's web.config file: <trust level="WSS_Minimal" originUrl="" /> Now change this to: <trust level="Full" originUrl="" /> Now you can write some code to access SharePoint data. This is just a question of learning and understanding the SharePoint API, which is worthy of several articles in its own right. Here I show a simple web part that displays the name of the presently logged in user: using System.Web.UI.WebControls.WebParts; using Microsoft.SharePoint; namespace ExampleWebPartLibrary { public class HelloUser : WebPart { protected override void Render(System.Web.UI.HtmlTextWriter writer) { // Get a contextual reference to the current SPWeb SPWeb currentWeb = SPContext.Current.Web; // Write a message to the current user writer.Write("Hello " + currentWeb.CurrentUser.LoginName); } } } SPContext.Current.Web is the starting point for accessing SharePoint data. For example you can use it to access data in lists and document libraries. Using SharePoint settings to manage your Web Part
Web Parts will invariably need settings in order to be useful. There are two ways of providing your web parts with settings in run time. In a bespoke environment it may be acceptable to place the settings in the web.config and access them in the same way as you would for standard ASP.NET applications. However if you require that users be able to easily configure and manage the web part themselves, then you need to Page 5 of 47
Page 6 of 47 use the SharePoint API to give the web part settings. This will almost certainly be the case if you are an Independent Software Vendor making a packaged release of your Web Part. Fortunately it's quite easy to settings-enable your web part. The following steps assume you are starting with an existing web part, but you can skip to the listing at the end of the article if you are starting from scratch. 1. Add the required using statements 2. using System; 3. 4. using System.ComponentModel; 5. using System.Runtime.InteropServices; 6. using System.Xml.Serialization; 7. 8. using Microsoft.SharePoint; using Microsoft.SharePoint.WebPartPages; 9. Change your web part to inherit from the Microsoft.SharePoint.WebPartPages.WebPart 10.Create a new guid for your web part. Add the Guid and XmlRoot attributes to your Web Part as follows: 11.[Guid("692b5ada-2f4c-45b0-b9a5-e718db958ae6")] 12.[XmlRoot(Namespace = "ExampleWebPartLibrarySettingsDemo")] public class SettingsDemo : Microsoft.SharePoint.WebPartPages.WebPart 13. Add the different attributes applied to the property that is used as a setting. Adjust the constant string attribute arguments according to your needs. 14.private string mySetting; 15. 16. // SharePoint setting with required attributes 17.[Browsable(true), 18.Category("Example Web Parts"), 19.DefaultValue("Default"), 20.WebPartStorage(Storage.Shared), 21.FriendlyName("MySetting"), 22.Description("An example setting")] 23.public string MySetting 24. { 25. get { return mySetting; } 26. set { mySetting = value; } } 27. Using the setting in code (in this case, the render method). The complete code listing is as follows: // using statements required for settings using System; using System.ComponentModel; using System.Runtime.InteropServices; using System.Xml.Serialization; using Microsoft.SharePoint; using Microsoft.SharePoint.WebPartPages; namespace ExampleWebPartLibrary { //Guid and XmlRoot attributes for a settings enabled web part [Guid("692b5ada-2f4c-45b0-b9a5-e718db958ae6")] Page 6 of 47
Page 7 of 47 [XmlRoot(Namespace = "ExampleWebPartLibrarySettingsDemo")] // NB inherit from SharePoint WebPart rather than ASP.NET Web Part public class SettingsDemo : Microsoft.SharePoint.WebPartPages.WebPart { private string mySetting; // SharePoint setting with required attributes [Browsable(true), Category("Example Web Parts"), DefaultValue("Default"), WebPartStorage(Storage.Shared), FriendlyName("MySetting"), Description("An example setting")] public string MySetting { get { return mySetting; } set { mySetting = value; } } // use the setting in code protected override void Render(System.Web.UI.HtmlTextWriter writer) { writer.Write("Value of MySetting: "); writer.Write(mySetting); } } }
SharePoint 2007 Flash Animation Web Part By Mahdi Abdulhamid
Page 7 of 47
Page 8 of 47
Introduction I've seen that many people are using HTML content web part for displaying Flash animation. I don't recommend this approach for many reasons, one of them being you won't tell your client to edit HTML code for changing Flash properties; so it is better to have a dedicated web part for rendering Flash animation. Software Requirements • Microsoft SharePoint 2007 installed (With Site Collection created on port:80) • SharePoint Services 3.0 Extensions for Visual Studio 2005 installed Using the code To apply the code, you will need to create a new SharePoint Webpart Project then overrides the web part class file: using System; using System.ComponentModel; using System.Runtime.InteropServices; using System.Web.UI; using System.Web.UI.WebControls.WebParts; using System.Web.UI.WebControls; using System.Xml.Serialization; using Microsoft.SharePoint; using Microsoft.SharePoint.WebControls; using Microsoft.SharePoint.WebPartPages; using Microsoft.SharePoint.Utilities; using System.Web.UI.HtmlControls; namespace FlashWebPart { [Guid("f04fa49d-1342-4c7d-904a-c43ebc942f39")] [XmlRoot(Namespace = "FlashWebPart")] public class FlashWebPart : Microsoft.SharePoint.WebPartPages.WebPart { public FlashWebPart() { this.ExportMode = WebPartExportMode.All; } protected int flashWidth = 400; protected int flashHeight = 300; Page 8 of 47
Page 9 of 47 protected string flashUrl = "";
Page 10 of 47 protected override void Render(HtmlTextWriter writer) { string outHTML = ""; writer.Write(outHTML); } } }
/w EPDw UKMTAy
Simple WebPart To Load UserControl By agusto xaverius It is a simple webpart but very usefull to load many usercontrols
Introduction Moss/WSS is so CMS popular currently. There are many thing can be which can be done and is modified at deep technology on that product. Work with on that solution will ever be utilize webpart. But if we develop one webpart sometimes we do ever make same old things which is make coding webpart and load the usercontrol what does we want. Background Page 10 of 47
Page 11 of 47 This concept is similiar with SmartPart which you just create one webpart and then it can be used to load all your usercontrol without writing webpart again. Using the Code The listing code is like this: 1. Write on your class solution like this. Please reference Microsoft.Sharepoint.dll component and System.Web.dll too. using System; using System.ComponentModel; using System.Text; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.WebControls.WebParts; using System.Xml.Serialization; using Microsoft.SharePoint; using Microsoft.SharePoint.Utilities; using Microsoft.SharePoint.WebPartPages; namespace WebPartLib { public class WebPartGeneral : Microsoft.SharePoint.WebPartPages.WebPart { private Control _childControl = null; private string _userControlVirtualPath = string.Empty; private string _errMessage = string.Empty; public WebPartGeneral() {} [ Personalizable(), Category("Miscellaneous"), DefaultValue(""), WebBrowsable(true), WebDisplayName("User Control Virtual Path"), WebDescription("User Control Virtual Path") ] public string UserControlVirtualPath { get { return _userControlVirtualPath; } set { _userControlVirtualPath = value; } } protected override void RenderWebPart(HtmlTextWriter output) { if (_errMessage != string.Empty) output.Write(_errMessage); if (_userControlVirtualPath != string.Empty || _userControlVirtualPath.Equals("") == false) RenderChildren(output); } protected override void RenderChildren(HtmlTextWriter output) { try Page 11 of 47
Page 12 of 47 { this.EnsureChildControls(); if (this._childControl != null) this._childControl.RenderControl(output); } catch (Exception ex) { _errMessage = string.Format( "Exception Message (RenderWebPart) = {0}
", ex.Message); } } protected override void CreateChildControls() { base.CreateChildControls(); if (_userControlVirtualPath != string.Empty) { if (_childControl != null) return; _childControl = Page.LoadControl(_userControlVirtualPath); if (_childControl != null) Controls.AddAt(0, _childControl); } } public override void Dispose() { } } } 2. After the solution already successfully compile and the put the binary into bin folder on your MOss/Wss site. After it also make one folder by which UserControls. 1. Modify your web.config eControl Assembly="WebPartLib, Version=1.0.0.0, Culture=neutral" Namespace="WebPartLib" TypeName="*" Safe="True" AllowRemoteDesigner="True" /> and change trust level from WSS_Minimal into Full. <trust level="Full" originUrl="" /> 4. If Necesary you can client restart your IIS and the back to your site again and list the webpart into list of webpart 5. Create new website solution and create a simple usercontrol and then copy all .ascx and .cs into UserControls folder 6. Now you can utilize webpart and set the virtual path into your usercontrols and the simsalabim your webpart now load your usercontrol. You can create another usercontrol again and you can add your webpart again and set the usercontrols to load.
Page 12 of 47
Page 13 of 47
WebPart Life CycleBy Fabio Barbieri This article examines the production of a simple WebPart in C# Page 13 of 47
Page 14 of 47
Introduction In Sharepoint 2007, a way to customize the environment pass is by building WebParts coded with one of the languages available in VS2005. In this article, we're going to examine the production of a simple WebPart in C#, to better comprehend the life cycle and later, look at events that the developer has to consider in order to get the correct execution of code. Use Case Description In this sample will be proposed a typical case where the selection of an item in a dropdown list raises the event of filling a second dropdown list (server-side event) with proper items to the value selected. Specifically, the first dropdown list contains a short nations list, the second dropdown list will be loaded with a short town list belonging to the nation selected. Besides the two dropdown lists are shown the steps regarding principal event routines and property Text of DropDownList nation. The complete Webpart will have the following rendering graphic:
The Web Part It is interesting to note that DropDownList nation has set ViewState and AutoPostBack to true. The article scope is to highlight the WebPart life Cycle and understand when the value of a control (i.e. Text property) that has ViewState set up to be true, becomes available. In practice, this happens when the user selects a nation changing the first dropdown list item which starts the Postback event, at which point the value of the new item is available. The Code As is possible to understand by the shown log, there are four predefined routines that take place in a WebPart Life Cycle: 1. OnInit: Typically in this routine we define controls that will be involved with WebPart: 2. protected override void OnInit(EventArgs e) 3. { 4. try 5. { 6. _divPanel = new Panel(); Page 14 of 47
Page 15 of 47 7. 8.
_ddlCountry = new DropDownList();
_ddlTown = new DropDownList(); 9. CreateChildControls: In this routine are defined control properties and methods previously declared. In most cases, we have to initialize the control's default value (as Text, Checked, Items, and so on) and activity that is possible to call just at first WebPart load, checking PostBack: 10.protected override void CreateChildControls() 11. { 12. try 13. { 14. base.CreateChildControls(); 15. _divPanel.ID = "_divPanel"; 16. _divPanel.BorderStyle = BorderStyle.Ridge; 17. _divPanel.Width = 250; 18. _divPanel.Height = 300; 19. _divPanel.BackColor = System.Drawing.Color.Gainsboro; 20. Controls.Add(_divPanel); 21. _ddlCountry.AutoPostBack = true; 22. _ddlCountry.ID = "_ddlCountry"; 23. _ddlCountry.Width = 150; 24. _ddlCountry.EnableViewState = true; 25. _ddlCountry.SelectedIndexChanged += 26. new EventHandler(_ddlCountry_SelectedIndexChanged); 27. _divPanel.Controls.Add(_ddlCountry); 28. _ddlTown.AutoPostBack = false; 29. _ddlTown.ID = "_ddlTown"; 30. _ddlTown.Width = 150; 31. _ddlTown.EnableViewState = true; 32. _divPanel.Controls.Add(_ddlTown); 33. 34. if (!Page.IsPostBack) ddlCountry_Load(); 35.OnPreRender: This is the routine where the control's value kept by ViewState (for example Item value set up by the user to DropDownList nation), is available. For this reason, it's normal to begin business procedure from here, and in our case we're going to load values for the second dropdown list (Town DropDownList) with the proper data: 36.protected override void OnPreRender(EventArgs e) 37. { 38. try 39. { 40. _sMex += "OnPreRender: " + _ddlCountry.Text + " "; 41. string sStateSelected = _ddlCountry.Text; 42. _ddlTown.Items.Clear(); 43. 44. switch (sStateSelected) 45. { 46. case "England": 47. ddlTown_Load("London", "Liverpool", "Bristol"); 48. break; 49. 50. case "Spain": Page 15 of 47
Page 16 of 47 51. 52. 53. 54. 55. 56. 57. 58. 59. 60.
ddlTown_Load("Madrid", "Barcelona", "Valencia"); break; case "Italy": ddlTown_Load("Rome", "Milan", "Florence"); break; default: ddlTown_Load("New York", "Tokio", "Paris"); break;
} 61.Render: That's the routine for HTML rendering WebPart: 62.protected override void Render(HtmlTextWriter writer) 63. { 64. _sMex += "Render: " + _ddlCountry.Text + "
"; 65. writer.Write("
"); 66. writer.Write(" "); 72. 73. if (_sErrDescription == "") 74. { 75. // dropdownlist State 76. writer.Write("
| "); 80. _ddlCountry.RenderControl(writer); 81. writer.Write(" | "); 82. writer.Write("
| "); 89. _ddlTown.RenderControl(writer); 90. writer.Write(" | "); 91. writer.Write("
