Freigeben über

Erstellen von Webparts für SharePoint

  • Artikel

Unter Verwendung von Webparts können Benutzer Inhalt, Darstellung und Verhalten der Seiten einer SharePoint-Website mithilfe eines Browsers ändern. Webparts sind serverseitige Steuerelemente, die in einer Webpartseite ausgeführt werden. Diese sind die Bausteine der Seiten, die auf einer SharePoint-Website angezeigt werden. Weitere Informationen finden Sie unter Baustein: Webparts.

Sie können Webparts in einer SharePoint-Website unter Verwendung von Vorlagen aus Visual Studio erstellen und debuggen.

Erstellen eines Webparts in Visual Studio

Um ein Webpart zu erstellen, fügen Sie jedem SharePoint-Projekt das Element Webpart hinzu. Sie können ein Element Webpart in einer Sandkastenlösung oder einer Farmlösung verwenden.

Wenn Sie ein Webpart mit einem Designer visuell entwerfen möchten, erstellen Sie ein Projekt vom Typ Visuelles Webpart, oder fügen Sie jedem SharePoint-Projekt ein Element Visuelles Webpart hinzu. Sie können ein Element Visuelles Webpart nur in einer Farmlösung verwenden.

Element „Webpart“

Das Element Webpart stellt Dateien bereit, die Sie verwenden können, um ein Webpart für eine SharePoint-Website zu entwerfen. Wenn Sie das Element Webpart 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
Elements.xml Enthält Informationen, die von der Funktionsdefinitionsdatei im Projekt verwendet werden, um das Webpart bereitzustellen.
WEBPART-Datei Stellt Informationen bereit, die SharePoint benötigt, um das Webpart in einem Webpartkatalog anzuzeigen.
Codedatei Enthält Methoden, die Steuerelemente zum Webpart hinzufügen und benutzerdefinierten Inhalt innerhalb des Webparts generieren.

Weitere Informationen finden Sie unter Vorgehensweise: Erstellen eines SharePoint-Webparts.

Element „Visuelles Webpart“

Ein visuelles Webpart ist ein Webpart, das Sie mit dem Visual Web Developer-Designer in Visual Studio erstellen. Ein visuelles Webpart funktioniert genauso wie jedes andere Webpart. Um einem Webpart Steuerelemente wie Schaltflächen und Textfelder hinzuzufügen, fügen Sie einer XML-Datei Code hinzu. Einem visuellen Webpart werden Steuerelemente jedoch hinzugefügt, indem sie aus der Toolbox von Visual Studio in das Webpart gezogen oder kopiert werden. Der Designer generiert dann den erforderlichen Code in der XML-Datei. Weitere Informationen finden Sie unter How to: Erstellen eines SharePoint-Webparts mithilfe eines Designers.

SharePoint-Steuerelemente

Visual Studio stellt einige Steuerelemente zum Erstellen von SharePoint-Seiten (beispielsweise Anwendungsseiten) bereit. Diese Steuerelemente werden in der Toolbox unter SharePoint-Steuerelemente angezeigt. Die Funktionalität dieser Steuerelemente ist vom Namespace Microsoft.SharePoint.WebControls abgeleitet, der ASP.NET-Serversteuerelemente enthält, die in SharePoint-Website- und Listenseiten verwendet werden.

Name des Steuerelements BESCHREIBUNG
AspMenu Fügt ein ASP-Menü ein. Weitere Informationen finden Sie unter Übersicht über das Menu-Steuerelement.
CssLink Fügt ein LINK-Element auf der ASPX-Seite ein und wendet mindestens ein externes Stylesheet an, das von CssRegistration definiert wird.
DateTimeControl Fügt ein DateTime-Steuerelement auf der ASPX-Seite ein.
FormDigest Fügt eine Sicherheitsvalidierung auf der ASPX-Seite ein.
ListProperty Gibt eine Eigenschaft einer angegebenen Liste zurück.
ProjectProperty Gibt eine globale Eigenschaft der aktuellen Website zurück.
RssLink Fügt einen Link zu einem RSS-Feed auf der ASPX-Seite ein.
ScriptLink Stellt Eigenschaften und Methoden zum Registrieren von Ressourcen (beispielsweise Skripts) auf einer Seite bereit, sodass sie angefordert werden können, wenn die Seite gerendert wird.
Design Wendet ein Design auf die ASPX-Seite an.

Debuggen eines Webparts

Sie können ein SharePoint-Projekt, das ein Webpart enthält, auf dieselbe Weise debuggen wie andere Visual Studio-Projekte. Wenn Sie den Visual Studio-Debugger starten, wird von Visual Studio die SharePoint-Website geöffnet.

Um mit dem Debuggen des Codes zu beginnen, fügen Sie das Webpart einer Webpartseite in SharePoint hinzu.

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

Einschränkungen für visuelle Webparts

Ab Visual Studio können Sie visuelle Webparts zu SharePoint-Sandkastenlösungen und -Farmlösungen hinzufügen. Allerdings weisen visuelle Webparts die folgenden Einschränkungen auf:

  • Visuelle Webparts unterstützen keine ersetzbaren Parameter. Weitere Informationen finden Sie unter Ersetzbare Parameter.

  • Benutzersteuerelemente oder visuelle Webparts können nicht per Drag&Drop in visuelle Webparts verschoben oder in visuelle Webparts kopiert werden. Diese Aktion führt zu Buildfehlern.

  • Visuelle Webparts bieten keine direkte Unterstützung von SharePoint-Servertoken wie $SPUrl. Weitere Informationen finden Sie im Abschnitt zu Einschränkungen von Token in visuellen Sandkasten-Webparts im Thema Problembehandlung von SharePoint-Lösungen.

  • Visuelle Webparts in einer Sandkastenlösung erhalten gelegentlich die Fehlermeldung „Die Sandkasten-Codeausführungsanforderung wurde abgelehnt, weil der Sandkasten-Codeausführungs-Hostdienst zu ausgelastet war, um die Anforderung zu verarbeiten.“ Weitere Informationen zu diesem Fehler finden Sie in diesem Beitrag im Blog des SharePoint-Entwicklerteams.

  • Serverseitiges JavaScript-Debugging wird in Visual Studio nicht unterstützt, clientseitiges JavaScript-Debugging hingegen schon.

    Obwohl Sie einer serverseitigen Markupdatei Inline-JavaScript hinzufügen können, wird das Debuggen nicht für die dem Markup hinzugefügten Haltepunkte unterstützt. Um JavaScript zu debuggen, verweisen Sie auf eine externe JavaScript-Datei in der Markupdatei und legen die Haltepunkte in der JavaScript-Datei fest.

  • Das Debugging von ASP.NET-Inlinecode muss in der generierten Codedatei statt in der Markupdatei ausgeführt werden.

  • Visuelle Webparts unterstützen die Verwendung der <@ Assembly Src=-Anweisung nicht.

  • SharePoint-Websteuerelemente und einige ASP.NET-Steuerelemente werden in der SharePoint-Sandkastenumgebung nicht unterstützt. Wenn nicht unterstützte Steuerelemente für ein visuelles Webpart in einer Sandkastenlösung verwendet werden, wird der Fehler "Der Typ- oder Namespacename 'Theme' ist im Namespace 'Microsoft.SharePoint.WebControls' nicht vorhanden" angezeigt.

    Weitere Informationen zu Sandkastenlösungen finden Sie unter Unterschiede zwischen Sandkasten- und Farmlösungen.

Erstellen von SharePoint-basierten Webparts im älteren Format

Sie können die Vorlagen in Visual Studio verwenden, um benutzerdefinierte ASP.NET 2.0-Webparts für SharePoint zu erstellen. ASP.NET 2.0-Webparts werden auf Grundlage der ASP.NET-Webpartinfrastruktur erstellt und werden als Typ für neue Projekte empfohlen.

In seltenen Fällen müssen Sie möglicherweise ein Webpart mit dem SharePoint-basierten Webpart im älteren Format erstellen. Sie können diese Typen von Webparts mithilfe von Visual Studio erstellen, jedoch stellt Visual Studio keine Vorlagen bereit, die speziell für das Erstellen dieser Webparts ausgelegt sind.

Weitere Informationen zu den Situationen, in denen ein SharePoint-basiertes Webpart im älteren Format erstellt werden sollte, finden Sie unter Webpartinfrastruktur in SharePoint Foundation. Weitere Informationen zum Erstellen eines SharePoint-basierten Webparts im älteren Format finden Sie in der exemplarischen Vorgehensweise zum Erstellen eines grundlegenden SharePoint-Webparts.

Titel BESCHREIBUNG
How to: Erstellen eines SharePoint-Webparts Zeigt das Erstellen von Webparts für SharePoint-Seiten.
How to: Erstellen eines SharePoint-Webparts mithilfe eines Designers Zeigt das Erstellen von Webparts für SharePoint mithilfe einer visuellen Entwurfsoberfläche.
How to: Erstellen eines Benutzersteuerelements für eine SharePoint-Anwendungsseite oder ein SharePoint-Webpart Zeigt, wie Sie benutzerdefinierte, wiederverwendbare Steuerelemente erstellen, die von Anwendungsseiten und Webparts genutzt werden können, die in SharePoint ausgeführt werden.
Exemplarische Vorgehensweise: Erstellen eines Webparts für SharePoint Beschreibt, wie ein Webpart für SharePoint entworfen wird.
Exemplarische Vorgehensweise: Erstellen eines Webparts für SharePoint mithilfe eines Designers Beschreibt, wie ein Webpart für SharePoint durch Ziehen von Steuerelementen auf eine visuelle Entwurfsoberfläche entworfen wird.
Exemplarische Vorgehensweise: Erstellen eines Silverlight-Webparts, das OData für SharePoint anzeigt Beschreibt, wie ein Webpart für SharePoint entworfen wird, das eine Silverlight-Anwendung hostet und Daten aus SharePoint-Listen anzeigt.