Exemplarische Vorgehensweise: Erstellen eines einfachen Webparts

  • Artikel

Letzte Änderung: Donnerstag, 1. September 2011

Gilt für: SharePoint Foundation 2010

Inhalt dieses Artikels
Erstellen eines Webparts
Hinzufügen einer Webparteigenschaft
Außerkraftsetzen der Render-Methode
Bereitstellen und Testen des Webparts

Diese exemplarische Vorgehensweise beschreibt die Schritte zum Erstellen eines einfachen benutzerdefinierten Webparts, das Sie zu den Seiten einer Website hinzufügen können. Es handelt sich um ein einfaches Webpart, das den Benutzern das Definieren einer benutzerdefinierten Meldung ermöglicht, die innerhalb des Webparts anzeigt wird. Dieses Webpart wird von der Webpartklasse Microsoft ASP.NET abgeleitet, was die empfohlene Vorgehensweise für SharePoint Foundation ist.

Weitere Informationen zu ASP.NET-Webparts finden Sie in der folgenden ASP.NET-Dokumentation: Lernprogramme für ASP.NET QuickStart und ASP.NET-Webpart-Steuerelemente.

Voraussetzungen

ASP.NET

SharePoint-Entwicklungstools in Microsoft Visual Studio 2010

Erstellen eines Webparts

So erstellen Sie ein Webpart

  1. Starten Sie SharePoint-Entwicklungstools in Visual Studio 2010.

  2. Zeigen Sie im Menü Datei auf Neu, und klicken Sie dann auf Projekt.

  3. Wählen Sie in Projekttypen unter Visual Basic oder C# die Option Leeres SharePoint-Projekt aus.

  4. Geben Sie Sample.DisplayMessage als Projektnamen ein. Klicken Sie dann auf OK.

  5. Wählen Sie im Assistenten zum Anpassen von SharePoint die Option Als Sandkastenlösung bereitstellen aus. Klicken Sie auf Fertig stellen.

  6. Klicken Sie im Projektmappen-Explorermit der rechten Maustaste auf das Projekt Sample.DisplayMessage, und wählen Sie Hinzufügen und dann Neues Element aus.

  7. Wählen Sie im Dialogfeld Neues Element hinzufügen die Vorlage Webpart aus, und geben Sie DisplayMessageWebPart im Feld Name ein. Klicken Sie auf Hinzufügen.

Hinzufügen einer Webparteigenschaft

Nach dem Hinzufügen des neuen Webparts fügen Sie eine Eigenschaft hinzu, die für das Webpart personalisiert werden kann. Die Webparteigenschaft bestimmt den Text, der innerhalb des Webparts gerendert wird. Dieser wird auf der Basis des einzelnen Benutzers personalisiert.

HinweisHinweis

Weitere Informationen zur Anpassung und Personalisierung finden Sie unter Webpart-Personalisierung.

Für Webparts, die auf der Basisklasse für ASP.NET-Webpart-Seiten basieren, werden die Tags, die für die anpassbaren Eigenschaften verwendet werden, anders als bei Webparts benannt, die auf der WebPart-Basisklasse basieren. In der folgenden Liste werden die einzelnen Eigenschaften beschrieben:

  • Durch das WebBrowsableAttribute-Attribut wird sichergestellt, dass die benutzerdefinierte Eigenschaft im Bearbeitungstoolbereich in SharePoint Foundation gerendert wird.

  • Das WebDescriptionAttribute-Attribut zeigt eine QuickInfo an, die Benutzer beim Bearbeiten der benutzerdefinierten Eigenschaft unterstützt.

  • Das WebDisplayNameAttribute-Attribut zeigt einen Anzeigenamen für die benutzerdefinierte Eigenschaft an.

  • Das PersonalizableAttribute-Attribut bestimmt, ob sich Änderungen an der benutzerdefinierten Eigenschaft auf alle oder einzelne Benutzer auswirken.

So erstellen Sie die Webparteigenschaft

  1. Kopieren Sie in der Datei DisplayMessageWebPart den folgenden Code, und fügen Sie ihn ein, um eine einfache anpassbare Eigenschaft zu erstellen.

    private string customMessage = "Hello, world!";

public string DisplayMessage
{
    get { return customMessage; }
    set { customMessage = value; }
}

    Private customMessage As String = "Hello, world!"

Public Property DisplayMessage() as String
    Get
        Return customMessage
    End Get
    Set(ByVal value as String)
        customMessage = value
    End Set
End Property

  2. Fügen Sie dann die folgenden Tags oberhalb der öffentlichen Deklaration hinzu, um Änderungen auf Benutzerbasis zuzulassen:

    [WebBrowsable(true),
WebDescription("Displays a custom message"),
WebDisplayName("Display Message"),
Personalizable(PersonalizationScope.User)]

    <WebBrowsable(True), _
WebDescription("Displays a custom message"), _
WebDisplayName("Display Message"), _
Personalizable(PersonalizationScope.User)> _

  3. Sie haben nun eine personalisierbare Webparteigenschaft erstellt.

Außerkraftsetzen der Render-Methode

Sie müssen nun Funktionalität zum Webpart hinzufügen. Indem Sie die Control.Render-Methode außer Kraft setzen, können Sie angeben, welche Operationen das Webpart bei einem Besuch der Seite ausführen soll. In diesem Beispiel rendert das Webpart den benutzerdefinierten Text.

So setzen Sie die Render-Methode außer Kraft

  • Kopieren Sie in der Datei DisplayMessageWebPart den folgenden Code, und fügen Sie ihn ein, um die Render-Methode außer Kraft zu setzen.

    protected override void Render(System.Web.UI.HtmlTextWriter writer)
{
    writer.Write(DisplayMessage);
}

    Protected Overrides Sub Render(ByVal writer As System.Web.UI.HtmlTextWriter)
    writer.Write(DisplayMessage)
End Sub

Bereitstellen und Testen des Webparts

So stellen Sie das Webpart bereit und testen es

  1. Drücken Sie die F5-TASTE, um das Webpart bereitzustellen.

  2. Klicken Sie, nachdem Sie Seite im Browser geöffnet wurde, auf die Schaltfläche Bearbeiten auf der Registerkarte Seite, um den Bearbeitungsmodus für die Seite zu aktivieren.

  3. Klicken Sie auf der Registerkarte Einfügen innerhalb der kontextbezogenen Gruppe Bearbeitungstools auf die Schaltfläche Webpart.

  4. Wählen Sie in der Liste Kategorien die Option Benutzerdefiniert und dann in der Liste der Webparts das Webpart DisplayMessageWebPart aus. Klicken Sie auf Hinzufügen. Das Webpart wird auf der Seite angezeigt und zeigt den Text Hello, world! an.

  5. Zum Ändern des Textes, der im Webpart angezeigt wird, wählen Sie das Webpart auf der Seite aus, öffnen Sie die Registerkarte Optionen in der kontextbezogenen Gruppe Webparttools, und klicken Sie auf die Schaltfläche Webparteigenschaften.

  6. Erweitern Sie im Eigenschaftenbereich DisplayMessageWebPart die Kategorie Verschiedene, und ändern Sie den Wert für Display Message. Klicken Sie auf Übernehmen.

  7. Das Webpart zeigt nun den benutzerdefinierten Wert innerhalb des Webparts an.