WebPart.GetToolParts-Methode
Bestimmt, welche Toolparts angezeigt werden, klicken Sie im Toolbereich die Entwurfsbenutzeroberfläche webbasierte-Webpart und die Reihenfolge, in der sie angezeigt werden.
Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
Public Overridable Function GetToolParts As ToolPart()
'Usage
Dim instance As WebPart
Dim returnValue As ToolPart()
returnValue = instance.GetToolParts()
public virtual ToolPart[] GetToolParts()
Rückgabewert
Typ: []
Ein Array vom Typ ToolPart , der bestimmt, welche Toolparts im Toolbereich angezeigt werden. Wenn ein Webpart, das eine oder mehrere benutzerdefinierte Eigenschaften implementiert nicht die GetToolParts -Methode außer Kraft, gibt die Basisklasse-Methode eine Instanz der WebPartToolPart -Klasse und einer Instanz der Klasse CustomPropertyToolPart zurück. Eine Instanz der Klasse WebPartToolPart zeigt ein Toolpart für das Arbeiten mit den Eigenschaften, die von der Basisklasse WebPart bereitgestellt. Eine Instanz der Klasse CustomPropertyToolPart zeigt eine integrierte Toolpart für benutzerdefinierten Webpart-Eigenschaften arbeiten, solange die benutzerdefinierte Eigenschaft eines der Typen von diesem Toolpart unterstützt wird. Die unterstützten Typen sind: String, Boolean, Integer, DateTimeoder Enum.
Hinweise
Beim Erstellen eines benutzerdefinierten Webparts, beinhaltet werden benutzerdefinierte Eigenschaften, die erfordern eine benutzerdefinierte Toolpart (eine Implementierung der ToolPart -Klasse), die GetToolParts -Methode, um die Liste der benutzerdefinierten Toolparts anzugeben außer Kraft setzen müssen in den Toolbereich gerendert.
Beispiele
Das folgende Codebeispiel zeigt eine überschriebene GetToolParts -Methode.
' Gets the custom tool parts for this Web Part by overriding the
' GetToolParts method of the WebPart base class. You must implement
' custom tool parts in a separate class that derives from
' Microsoft.SharePoint.WebPartPages.ToolPart.
' Returns an array of references to ToolPart objects.
Public Overrides Function GetToolParts()As ToolPart()
Dim toolParts(2) As ToolPart
Dim wptp As WebPartToolPart = New WebPartToolPart()
Dim custom As CustomPropertyToolPart = New CustomPropertyToolPart()
toolparts(0) = wptp
toolparts(1) = custom
Return toolparts
End Function
/// <summary>
/// Gets the custom tool parts for this Web Part by overriding the
/// GetToolParts method of the WebPart base class. You must implement
/// custom tool parts in a separate class that derives from
/// Microsoft.SharePoint.WebPartPages.ToolPart.
/// </summary>
/// <returns>An array of references to ToolPart objects.</returns>
public override ToolPart[] GetToolParts()
{
ToolPart[] toolparts = new ToolPart[2];
WebPartToolPart wptp = new WebPartToolPart();
CustomPropertyToolPart custom = new CustomPropertyToolPart();
toolparts[0] = wptp;
toolparts[1] = custom;
return toolparts;
}