WebPart.GetToolParts - Méthode
Détermine quels composants de l'outil sont affichés dans le volet d'outils de l'interface utilisateur de conception basée sur le Web des composants WebPart et l'ordre dans lequel elles sont affichées.
Espace de noms : Microsoft.SharePoint.WebPartPages
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)
Syntaxe
'Déclaration
Public Overridable Function GetToolParts As ToolPart()
'Utilisation
Dim instance As WebPart
Dim returnValue As ToolPart()
returnValue = instance.GetToolParts()
public virtual ToolPart[] GetToolParts()
Valeur renvoyée
Type : []
Tableau de type ToolPart qui détermine quels composants de l'outil seront affichera dans le volet d'outils. Si un composant WebPart qui implémente une ou plusieurs propriétés personnalisées ne remplace pas la méthode GetToolParts , la méthode de classe de base renvoie une instance de la classe WebPartToolPart et une instance de la classe CustomPropertyToolPart . Une instance de la classe WebPartToolPart affiche une partie de l'outil permettant de manipuler les propriétés fournies par la classe de base WebPart . Une instance de la classe CustomPropertyToolPart affiche une partie de l'outil intégré permettant d'utiliser les propriétés personnalisées du composant WebPart, dans la mesure où la propriété personnalisée est de l'un des types pris en charge par cette partie de l'outil. Les types pris en charge sont : String, Boolean, Integer, DateTimeou Enum.
Remarques
Lors de la création d'un composant WebPart personnalisé qui inclut des propriétés personnalisées qui nécessitent une partie de l'outil personnalisé (une implémentation de la classe ToolPart ), vous devez substituer la méthode GetToolParts pour spécifier la liste des composants de l'outil personnalisé qui sont restituées à l'intérieur du volet d'outils.
Exemples
L'exemple de code suivant illustre une méthode substituée GetToolParts .
' 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;
}