This article discusses: The WSS and SPS object models Web Part Page anatomy Creating and deploying Web Parts Web Part security

This article uses the following technologies: SharePoint, ASP.NET, C#

Code download available at: WebParts.exe (204 KB)
Browse the Code Online

 Contents

The WSS and SPS Object Models
Web Part Infrastructure
Writing a Custom Web Part
Web Part Customization and Personalization
Other Web Part Development Features
Web Part Deployment and Distribution
Importing Web Parts
Conclusion

 Figure 1 Enumerating the Lists of a Virtual Server

// get GlobalAdmin object for current WSS deployment
SPGlobalAdmin globalAdmin = new SPGlobalAdmin();

// enumerate through IIS Virtual Servers
foreach(SPVirtualServer vServer in globalAdmin.VirtualServers)  
{
  // determine which IIS Virtual Servers are extended with WSS
  if(vServer.State == SPVirtualServerState.Ready) 
  {
    // enumerate through Site Collections of each Virtual Server
    foreach(SPSite siteCollection in vServer.Sites)
    {
      // enumerate through Sites of each Site Collection
      foreach(SPWeb site in siteCollection.AllWebs) 
      {
        // enumerate through Lists of each Site
        foreach(SPList list in site.Lists) 
        {
          Console.WriteLine(list.Title);
        }
      }
    }
  }
}

 Figure 2 SharePoint Site Browser

 Figure 3 Modify Shared Page

 Figure 6 Rendering in a Custom Web Part

override void RenderWebPart(ByVal output As HtmlTextWriter) {

  // create HTML table with custom attributes
  output.AddAttribute(HtmlTextWriterAttribute.Cellpadding, "5");
  output.AddAttribute(HtmlTextWriterAttribute.Border, "2");
  output.RenderBeginTag(HtmlTextWriterTag.Table);

  // create new row
  output.RenderBeginTag(HtmlTextWriterTag.Tr);

  // create new cell
  output.RenderBeginTag(HtmlTextWriterTag.Td);
  output.Write("Name:");
  output.RenderEndTag();      // </td>

  // create new cell
  output.RenderBeginTag(HtmlTextWriterTag.Td);
  output.Write("Bob Smith");
  output.RenderEndTag();      // </td>

  output.RenderEndTag();      // </tr>
  output.RenderEndTag();      // </table>
}

 Figure 7 Custom Web Part with Child Controls

public class JasonsWebPart : WebPart {
  
  // fields to hold child controls
  protected TextBox txtName;
  protected Button btnSubmit;
  
  // create child control
  protected override void CreateChildControls() {
    txtName = new TextBox();
    this.Controls.Add(txtName);
    btnSubmit = new Button();
    btnSubmit.Text = "Submit Name";
    this.Controls.Add(btnSubmit);
  }
  
  // render HTML for Web Part
  protected override void RenderWebPart(HtmlTextWriter output) {
    txtName.RenderControl(output);
    output.RenderBeginTag(HtmlTextWriterTag.Br);
    btnSummit.RenderControl(output);
  }
}

 Figure 8 Persisting Personalization Settings

[XmlRoot(Namespace="AcmeWebParts")]
public class WeatherReportWebPart : WebPart {

  // Web Part property attributes
  [WebPartStorage(Storage.Personal), 
   DefaultValue(""),
   Browsable(true),
   FriendlyName("Zip Code"),
   Category("User Info")]
  public string ZipCode {
    get { return _ZipCode; }
    set { _ZipCode = value; }
  }

  // field used as backing store for ZipCode property
  protected string _ZipCode = string.Empty;
}

 Figure 9 Web Part Description File

<?xml version="1.0" encoding="utf-8"?>
<WebPart xmlns="http://schemas.microsoft.com/WebPart/v2" >

    <!-- display information for Web Part consumers -->
    <Title>Weather Report</Title>
    <Description>Acme Weather Report Web Part</Description>

    <!-- type information for loading Web Part at run time -->
    <Assembly>AcmeWebParts</Assembly>
    <TypeName>AcmeWebParts.WeatherReportWebPart</TypeName>

    <!-- property initialization values -->
    <ZipCode xmlns="AcmeWebParts">98052</ZipCode>

</WebPart>

 Figure 10 manifest.xml

<?xml version="1.0"?>
<WebPartManifest xmlns="http://schemas.microsoft.com/WebPart/v2/ 
   Manifest">
  <Assemblies>
    <Assembly FileName="AcmeWebParts.dll">
      <SafeControls>
        <SafeControl Namespace="AcmeWebParts" TypeName="*" />
      </SafeControls>
    </Assembly>
  </Assemblies>
  <DwpFiles>
    <DwpFile FileName="TedsWebPart.dwp"/>
    <DwpFile FileName="JasonsWebPart.dwp"/>
    <DwpFile FileName="WeatherReportWebPart.dwp"/>
  </DwpFiles>
</WebPartManifest>