Erstellen von wiederverwendbaren Steuerelementen für Webparts oder Anwendungsseiten

In Visual Studio können Sie benutzerdefinierte, wiederverwendbare Steuerelemente für in SharePoint ausgeführte Anwendungsseiten und Webparts erstellen. Diese Steuerelemente werden als Benutzersteuerelemente bezeichnet. Ein Benutzersteuerelement ist ein zusammengesetztes Steuerelement, das ähnlich wie eine ASP.NET-Webseite funktioniert: Sie können einem Benutzersteuerelement vorhandene Webserver-Steuerelemente und Markup hinzufügen und Eigenschaften und Methoden für das Steuerelement definieren. Anschließend können Sie all dies in ASP.NET-Webseiten einbetten, wo es als Einheit fungiert.

Erstellen eines Benutzersteuerelements

Fügen Sie einem leeren SharePoint-Projekt ein Benutzersteuerelement hinzu, um ein Benutzersteuerelement zu erstellen. Weitere Informationen finden Sie unter Vorgehensweise: Erstellen eines Benutzersteuerelements für eine SharePoint-Anwendungsseite oder ein SharePoint-Webpart.

Wenn Sie das Element Benutzersteuerelement hinzufügen, erstellt Visual Studio einen Ordner im Projekt und fügt diesem Ordner dann mehrere Dateien hinzu. In der folgenden Tabelle werden die einzelnen Dateien beschrieben.

Datei	BESCHREIBUNG
Datei des Benutzersteuerelements	Enthält die Definition des Benutzersteuerelements. Entwerfen Sie das Benutzersteuerelement, indem Sie dieser Datei Steuerelemente und Markup hinzufügen.
Codedatei	Enthält den Code hinter dem Benutzersteuerelement. Fügen Sie dieser Datei Code hinzu, um die Verarbeitung von Ereignissen zu konfigurieren.
Datei des Designercodes	Beinhaltet vom Designer generierten Code und sollte nicht direkt bearbeitet werden

Entwerfen des Benutzersteuerelements

Entwerfen Sie das Benutzersteuerelement mit dem Visual Web Developer-Designer in Visual Studio. Dieser Designer wird angezeigt, wenn Sie die Datei des Benutzersteuerelements in Ihrem Projekt öffnen und auf die Registerkarte Entwurf klicken.

Verwenden des Benutzersteuerelements

Benutzersteuerelemente werden erst in SharePoint angezeigt, wenn Sie diese in eine Anwendungsseite oder ein Webpart einbetten.

Öffnen Sie dazu die Webseite, der Sie das ASP.NET-Benutzersteuerelement hinzufügen möchten. Wechseln Sie zur Designansicht, klicken Sie im Projektmappen-Explorer auf die Datei des benutzerdefinierten Benutzersteuerelements, und ziehen Sie diese auf die Seite. Das ASP.NET-Benutzersteuerelement wird der Seite hinzugefügt, und der Designer erstellt die erforderliche „@ Register“-Anweisung, damit die Seite das Benutzersteuerelement erkennt. Nun können Sie mit den öffentlichen Eigenschaften und Methoden des Steuerelements arbeiten.

Fügen Sie das Benutzersteuerelement in der Codedatei des Webparts der Controls-Sammlung hinzu, um ein Benutzersteuerelement in ein Webpart einzubetten. Im folgenden Beispiel wird ein Benutzersteuerelement der Controls-Sammlung eines Webparts hinzugefügt.

C#

[ToolboxItemAttribute(false)]
public class VisualWebPart1 : WebPart
{
    private const string _ascxPath = @"~/_CONTROLTEMPLATES/CS/VisualWebPart1/VisualWebPart1UserControl.ascx";

    public VisualWebPart1()
    {
    }

    protected override void CreateChildControls()
    {
        Control control = this.Page.LoadControl(_ascxPath);
        Controls.Add(control);
        base.CreateChildControls();
    }

    protected override void RenderContents(HtmlTextWriter writer)
    {
        base.RenderContents(writer);
    }
    
}

VB

<ToolboxItemAttribute(false)> _
Public Class VisualWebPart1
    Inherits WebPart

    Private Const _ascxPath As String = "~/_CONTROLTEMPLATES/VB/VisualWebPart1/VisualWebPart1UserControl.ascx"

    Public Sub New()
    End Sub

    Protected Overrides Sub CreateChildControls()
        Dim control As Control = Page.LoadControl(_ascxPath)
        Controls.Add(control)
        MyBase.CreateChildControls()
    End Sub

    Protected Overrides Sub RenderContents(ByVal writer As HtmlTextWriter)
        MyBase.RenderContents(writer)
    End Sub

End Class

Debuggen eines Benutzersteuerelements

Stellen Sie zum Debuggen eines Benutzersteuerelements sicher, dass das Benutzersteuerelement in einer Anwendungsseite oder einem Webpart in Ihrem SharePoint-Projekt enthalten ist. Wenn dem so ist, können Sie den Code im Benutzersteuerelement genauso wie jeden anderen Code in einem beliebigen Visual Studio-Projekt debuggen.

Wenn Sie den Visual Studio-Debugger starten, wird von Visual Studio die SharePoint-Website geöffnet.

Öffnen Sie in SharePoint die Anwendungsseite, die das Benutzersteuerelement enthält. Wenn das Benutzersteuerelement in einem Webpart enthalten ist, fügen Sie das Webpart in SharePoint zu einer Webpartseite hinzu.

Weitere Informationen zum Debuggen von SharePoint-Projekten finden Sie unter Problembehandlung von SharePoint-Lösungen.

Verwandte Themen

Titel	BESCHREIBUNG
How to: Erstellen eines Benutzersteuerelements für eine SharePoint-Anwendungsseite oder ein SharePoint-Webpart	In diesem Artikel erfahren Sie, wie Sie benutzerdefinierte, wiederverwendbare Steuerelemente für in SharePoint ausgeführte Anwendungsseiten und Webparts erstellen.