Compartilhar via


ICustomizeToolPane.ToolPaneTemplate property

Obtém um String que contém um fragmento XML que especifica um modelo para um painel de ferramentas personalizadas.

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

Syntax

'Declaração
ReadOnly Property ToolPaneTemplate As String
    Get
'Uso
Dim instance As ICustomizeToolPane
Dim value As String

value = instance.ToolPaneTemplate
string ToolPaneTemplate { get; }

Property value

Type: System.String
Um fragmento XML que define um modelo para um painel de ferramentas personalizadas.

Comentários

O esquema para o fragmento XML é da seguinte maneira.

<?xml version=”1.0”?>
<ToolPane>
    <Caption></Caption>
    <ErrorUI></ErrorUI>
    <NotifyUI></NotifyUI>
    <ToolParts></ToolParts>
    <Commands></Commands>
    <FixedArea></FixedArea>
</ToolPane>

Elemento

Descrição

Caption

O elemento Caption Especifica o título do painel de ferramentas e se deseja exibir o botão Fechar. Este elemento deve ser marca vazia (não pode haver nenhum filho). Os atributos do elemento Caption são descritos na tabela a seguir:

  • title   Especifica o texto que aparece na barra de título do painel de ferramentas. Valor padrão: em branco. Valor permitido: HTML que especifica o título.

  • closeButton   Especifica se o botão Fechar para o painel de ferramentas é exibido.
    Valor padrão: true (o botão é exibido)
    valor permitido: false (não o botão)

ErrorUI

O elemento ErrorUI Especifica o local das mensagens de erro dentro do corpo do painel de ferramenta. Este elemento tem nenhum filho e sem atributos.

NotifyUI

O elemento NotifyUI Especifica o local de várias notificações dentro do corpo do painel de ferramenta. Este elemento tem nenhum filho e sem atributos.

ToolParts

O elemento ToolParts Especifica as partes da ferramenta que são exibidas no painel de ferramentas. Ferramenta de todas as partes são exibidas na ordem a aparência dos elementos ToolPart ele contém, quais são os elementos filho somente aceitável do elemento ToolParts . Este elemento não tem atributos.

ToolPart

O elemento ToolPart especifica parte de uma única ferramenta e só pode ser exibido como um filho do elemento ToolParts . Este elemento não tem filhos. Os atributos do elemento ToolPart são descritos na lista a seguir:

  • type   Uma cadeia de caracteres que especifica o nome totalmente qualificado da parte de ferramenta. Este atributo deve estar presente na marca.

Commands

O elemento Commands Especifica os botões de comando que são exibidos na área de comando do painel de ferramentas. Esse elemento não pode ter nenhum filho. Os atributos do elemento Commands são descritos na tabela a seguir:

  • ok   Especifica se o botão OK está presente.
    Valor padrão: true
    valor permitido: falso

  • apply   Especifica se o botão Apply está presente.
    Valor padrão: true
    valor permitido: falso

  • cancel   Especifica se o botão Cancel está presente.
    Valor padrão: true
    valor permitido: falso

FixedArea

O elemento FixedArea Especifica uma área dentro do painel de ferramentas que pode conter links ou controles, como botões que aparecem no painel de ferramentas fora da área de comandos. Esta marca não pode ter nenhum filhos ou atributos.

Para ver um exemplo de código que especifica a propriedade ToolPaneTemplate , consulte ToolPane.

Ver também

Referência

ICustomizeToolPane interface

ICustomizeToolPane members

Microsoft.SharePoint.WebPartPages namespace