Hello World WebPart mit Visual Studio 2005

Dieser Beitrag beschreibt mit einer Step-by-Step Anleitung die Entwicklung eines "Hello World WebParts" mit Visual Studio 2005 und Visual Studio 2005 extensions for Windows SharePoint Services 3.0 Version 1.1.

Für das folgende Beispielprojekt benötigt ihr eine Windows SharePoint Services 3.0 (WSS 3.0) oder Office SharePoint Server 2007 (MOSS 2007) Installation mit Visual Studio 2005 mit Visual Studio 2005 extensions for Windows SharePoint Services 3.0.

Schritt 1: File - New - Project auswählen

Schritt 2: Visual C# - Web Part Template auswählen und HelloWorldWebPart als Projektname-Projectname definieren. Anschliessend OK-Button klicken.

Im Visual Studio 2005 wird folgender Code automatisch erstellt.

Schritt 3: In diesem Schritt erweitern wir den Code. Im Render-Ereignis wird der Text "Hello World WebPart" mithilfe der Write-Methode ausgegeben. Und im OnPreRender-Ereignis definieren wir den Title-Eigenschaft-Property unseren WebParts.

using System;
using System.Runtime.InteropServices;
using System.Web.UI;
using System.Web.UI.WebControls.WebParts;
using System.Xml.Serialization;

using Microsoft.SharePoint;
using Microsoft.SharePoint.WebControls;
using Microsoft.SharePoint.WebPartPages;

namespace HelloWorldWebPart
{
   [Guid("9aadb963-b0b0-4c99-8b93-d32b8dbbf717")]
   public class HelloWorldWebPart : System.Web.UI.WebControls.WebParts.WebPart
   {
       public HelloWorldWebPart()
       {
           this.ExportMode = WebPartExportMode.All;
       }

       protected override void Render(HtmlTextWriter writer)
       {
           // TODO: add custom rendering code here.
            writer.Write("Hello World WebPart");
       }

       protected override void OnPreRender(EventArgs e)
       {
           this.Title = "Hello World";
       }
   }
}

Schritt 4: Im nächsten Schritt werden wir die Projekt-Eigenschaften ändern. Project - HelloWorldWebPart Properties auswählen.

Schritt 5: Wenn wir unseren WebPart direkt vom Visual Studio aus verteilen möchten, dann müssen wir angeben, wie unser Server heisst, auf dem wir unser WebPart verteilen möchten. In meinem Beispiel hat mein SharePoint Server 2007 den Namen SRV-031.

Schritt 6: In diesem Schritt werden wir unseren HelloWorldWebPart kompilieren. Build - Build HelloWorldWebPart auswählen.

Schritt 7a: Nach einer fehlerfreien Kompilierung können wir jetzt unseren WebPart verteilen. Build - Deploy HelloWorldWebPart auswählen.

Schritt 7b: Die Fehlermeldung-Error Message No SharePoint Site exists at the speicifed URL.

Dieser Meldung haben wir erhalten, weil wir im Projekt-Eigenschaften-Dialog - Project Properties Dialog nur den Servernamen definiert aber keine SiteCollection angegeben haben.

Schritt 7c: Nochmals den Projekt-Eigenschaft - Project Properties Dialog aufrufen und die URL mit SiteCollection ergänzen. In meinem Beispiel heisst meiner SiteCollection SiteCol001.

Jetzt können wir nochmals versuchen, unseren WebPart zu verteilen.Build - Deploy HelloWorldWebPart auswählen.

Schritt 7d: Wenn der angemeldeter Benutzer nicht genügend Recte auf dieser SiteCollection besitzt, dann kann der WebPart nicht verteilt werden. Visual Studio meldet sich dann mit der Meldung Attempted to perform an unauthorized operation.

Schritt 7e: SiteColleciton aufrufen und dann Site Actions - Site Settings aufrufen.

Unter Users and Permissions - Site Collection administrators können wir unseren User als Site Collection Adminisitrator hinzufügen.

Ihr Login eintragen und mit OK bestätigen.

Schritt 7f: Build - Deploy HelloWorldWebPart auswählen. Wenn ihr unten die Meldung Deploy succeeded sieht, dann bedeutet dies, dass die Verteilung erfolgreich war.

Schritt 8: Als nächstes können wir kontrollieren, ob unser HelloWorldWebPart in unser SiteCollection zur Verfügung steht. Nochmals SiteCollection aufrufen und dann Site Actions - Site Settings. Anschliessend Galleries - Web Parts auswählen.

In der Liste finden wir unseren HelloWorldWebPart. Jetzt können wir unseren neuen WebPart verwenden.

Schritt 9: Nochmals SiteCollection öffnen und diesmal unter Site Actions - Edit Page auswählen. Mit Edit Page können wir die Seite umgestaltet und auch neuen WebPart hinzufügen.

Anschlissend wird der Ansicht wie folgt aussehen:

Hier Add a WebPart klicken und unseren WebPart HelloWorldWebPart auswählen. Anschliessend den Add-Button klicken.

Unseren WebPart konnten wir so auf unser Seite platzieren. Der Titel Hello World und Text Hello World WebPart werden angezeigt.

Viel Spass...