GenericWebPart.Description Propriedade
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Obtém ou define uma frase curta que resume o que um controle faz, para ser usada em dicas de ferramenta e catálogos de controles de servidor.
public:
virtual property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };
public override string Description { get; set; }
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. O valor padrão é uma cadeia de caracteres vazia ("").
Exemplos
O exemplo de código a seguir demonstra o uso declarativo e programático da Description propriedade . O código-fonte completo do exemplo é encontrado na seção Exemplo do GenericWebPart tópico de visão geral.
A primeira parte do exemplo de código mostra como a Description propriedade é definida declarativamente em um controle de servidor dentro de um WebPartZone controle.
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<asp:Calendar ID="Calendar1" runat="server"
Title="My Calendar"
Description="A calendar used as a GenericWebPart control."
CatalogIconImageUrl="MyCatalogIcon.gif"
TitleIconimageUrl ="MyTitleIcon.gif"
TitleUrl="MyInfoUrl.htm"
Width="250"/>
</ZoneTemplate>
</asp:WebPartZone>
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<asp:Calendar ID="Calendar1" runat="server"
Title="My Calendar"
Description="A calendar used as a GenericWebPart control."
CatalogIconImageUrl="MyCatalogIcon.gif"
TitleIconimageUrl ="MyTitleIcon.gif"
TitleUrl="MyInfoUrl.htm"
Width="250"/>
</ZoneTemplate>
</asp:WebPartZone>
A segunda parte do exemplo de código demonstra como acessar a propriedade programaticamente para exibir seu valor em um rótulo.
protected void Button1_Click(object sender, EventArgs e)
{
Label2.Text =
@"<h3>Calendar GenericWebPart Properties</h3>" +
"<em>Title: </em>" + calendarPart.Title +
"<br />" +
"<em>CatalogIconImageUrl: </em>" + calendarPart.CatalogIconImageUrl +
"<br />" +
"<em>TitleUrl: </em>" + calendarPart.TitleUrl +
"<br />" +
"<em>Decription: </em>" + calendarPart.Description +
"<br />" +
"<em>TitleIconImageUrl: </em>" + calendarPart.TitleIconImageUrl +
"<br />" +
"<em>ChildControl ID: </em>" + calendarPart.ChildControl.ID +
"<br />" +
"<em>ChildControl Type: </em>" + calendarPart.ChildControl.GetType().Name +
"<br />" +
"<em>GenericWebPart ID: </em>" + calendarPart.ID +
"<br />" +
"<em>GenericWebPart Type: </em>" + calendarPart.GetType().Name +
"<br />" +
"<em>GenericWebPart Parent ID: </em>" + calendarPart.Parent.ID;
Label3.Text =
@"<h3>BulletedList GenericWebPart Properties</h3>" +
"<em>Title: </em>" + listPart.Title +
"<br />" +
"<em>CatalogIconImageUrl: </em>" + listPart.CatalogIconImageUrl +
"<br />" +
"<em>TitleUrl: </em>" + listPart.TitleUrl +
"<br />" +
"<em>Decription: </em>" + listPart.Description +
"<br />" +
"<em>TitleIconImageUrl: </em>" + listPart.TitleIconImageUrl +
"<br />" +
"<em>ChildControl ID: </em>" + listPart.ChildControl.ID +
"<br />" +
"<em>ChildControl Type: </em>" + listPart.ChildControl.GetType().Name +
"<br />" +
"<em>GenericWebPart ID: </em>" + listPart.ID +
"<br />" +
"<em>GenericWebPart Type: </em>" + listPart.GetType().Name +
"<br />" +
"<em>GenericWebPart Parent ID: </em>" + listPart.Parent.ID;
}
Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)
Label2.Text = _
"<h3>Calendar GenericWebPart Properties</h3>" & _
"<em>Title: </em>" & calendarPart.Title & _
"<br />" & _
"<em>CatalogIconImageUrl: </em>" & calendarPart.CatalogIconImageUrl & _
"<br />" & _
"<em>TitleUrl: </em>" & calendarPart.TitleUrl & _
"<br />" & _
"<em>Decription: </em>" & calendarPart.Description & _
"<br />" & _
"<em>TitleIconImageUrl: </em>" & calendarPart.TitleIconImageUrl & _
"<br />" & _
"<em>ChildControl ID: </em>" & calendarPart.ChildControl.ID & _
"<br />" & _
"<em>ChildControl Type: </em>" & calendarPart.ChildControl.GetType().Name & _
"<br />" & _
"<em>GenericWebPart ID: </em>" & calendarPart.ID & _
"<br />" & _
"<em>GenericWebPart Type: </em>" & calendarPart.GetType().Name & _
"<br />" & _
"<em>GenericWebPart Parent ID: </em>" & calendarPart.Parent.ID
Label3.Text = _
"<h3>BulletedList GenericWebPart Properties</h3>" & _
"<em>Title: </em>" & listPart.Title & _
"<br />" & _
"<em>CatalogIconImageUrl: </em>" & listPart.CatalogIconImageUrl & _
"<br />" & _
"<em>TitleUrl: </em>" & listPart.TitleUrl & _
"<br />" & _
"<em>Decription: </em>" & listPart.Description & _
"<br />" & _
"<em>TitleIconImageUrl: </em>" & listPart.TitleIconImageUrl & _
"<br />" & _
"<em>ChildControl ID: </em>" & listPart.ChildControl.ID & _
"<br />" & _
"<em>ChildControl Type: </em>" & listPart.ChildControl.GetType().Name & _
"<br />" & _
"<em>GenericWebPart ID: </em>" & listPart.ID & _
"<br />" & _
"<em>GenericWebPart Type: </em>" & listPart.GetType().Name & _
"<br />" & _
"<em>GenericWebPart Parent ID: </em>" & listPart.Parent.ID
End Sub
End Class
Comentários
O Description valor da propriedade normalmente é usado como uma cadeia de caracteres descritiva para um controle em catálogos que fornecem listas de controles de servidor e como uma Dica de Ferramenta na barra de título de um controle. O conteúdo da propriedade aparece em uma Dica de Ferramenta quando um usuário posiciona o ponteiro do mouse sobre o texto do título na barra de título de um controle.
Essa propriedade substitui a propriedade base para que você possa acessar a propriedade no controle filho como se fosse um controle verdadeiro WebPart .
Você pode definir valores para a propriedade em seu controle na marcação declarativa de uma página da Web, bem como programaticamente. Para fornecer um valor padrão para a propriedade sempre que o controle for usado, você pode implementar a IWebPart interface .