Compartilhar via


WebPart.GetToolParts method

Determina quais partes de ferramenta são exibidas no painel de ferramentas de interface do usuário baseado na Web Part do Web design e a ordem em que eles são exibidos.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaração
Public Overridable Function GetToolParts As ToolPart()
'Uso
Dim instance As WebPart
Dim returnValue As ToolPart()

returnValue = instance.GetToolParts()
public virtual ToolPart[] GetToolParts()

Valor retornado

Type: []
Uma matriz de tipo ToolPart que determina quais partes da ferramenta serão exibidas no painel de ferramentas. Se uma Web Part que implementa um ou mais propriedades personalizadas não substitui o método GetToolParts , o método de classe base retornará uma instância da classe WebPartToolPart e uma instância da classe CustomPropertyToolPart . Uma instância da classe WebPartToolPart exibe uma parte da ferramenta para trabalhar com as propriedades fornecidas pela classe base WebPart . Uma instância da classe CustomPropertyToolPart exibe uma parte de uma ferramenta interna para trabalhar de propriedades de Web Parts personalizadas, desde que a propriedade personalizada é de um dos tipos suportados dessa parte da ferramenta. Os tipos suportados são: String, Boolean, Integer, DateTimeou Enum.

Comentários

Ao criar uma Web Part personalizada que inclui as propriedades personalizadas que exigem uma parte da ferramenta personalizada (uma implementação da classe ToolPart ), você deve substituir o método GetToolParts para especificar a lista de partes de ferramenta personalizada nas que são renderizadas dentro do painel de ferramentas.

Examples

O exemplo de código a seguir mostra um método substituído 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;
}

Ver também

Referência

WebPart class

WebPart members

Microsoft.SharePoint.WebPartPages namespace