Compartilhar via


WebPart.Description Propriedade

Definição

Obtém ou define uma breve frase que resume o que o controle de parte faz, para uso em Dicas de Ferramentas e catálogos de controles de parte.

public:
 virtual property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };
[System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)]
public override string Description { get; set; }
[<System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)>]
member this.Description : string with get, set
Public Overrides Property Description As String

Valor da propriedade

Uma cadeia de caracteres que resume brevemente a funcionalidade do controle de parte. O valor padrão é uma cadeia de caracteres vazia ("").

Implementações

Atributos

Comentários

A Description propriedade normalmente é uma cadeia de caracteres usada em catálogos que fornecem listas de controles de parte e como uma Dica de Ferramenta na barra de título do controle de parte. O conteúdo da Description propriedade aparece em uma Dica de Ferramenta quando você posiciona o ponteiro do mouse sobre o texto do título na barra de título de um controle de parte. O texto tooltip é criado a partir do valor da DisplayTitle propriedade, seguido por um hífen, seguido pelo valor da Description propriedade.

Para obter um exemplo de código que usa essa propriedade, consulte a propriedade base Description .

O escopo de personalização dessa propriedade é definido Shared e pode ser modificado somente por usuários autorizados. Para obter mais informações, consulte PersonalizableAttribute e Visão geral da Personalização de Web Parts.

Aplica-se a

Confira também