WebPartDescription.Description Propriedade

Definição

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Obtém o texto de uma descrição de um controle de WebPart.

public:
 property System::String ^ Description { System::String ^ get(); };

public string Description { get; }

member this.Description : string

Public ReadOnly Property Description As String

Valor da propriedade

String

Uma cadeia de caracteres que contém a descrição de um WebPart controle; o valor padrão é uma cadeia de caracteres vazia ("").

Exemplos

O exemplo de código a seguir demonstra o uso programático da Description propriedade . Para obter o código completo necessário para executar este exemplo de código, consulte a seção Exemplo do tópico de visão geral da WebPartDescription classe.

O código a Button1_Click seguir no método de uma página da Web demonstra como obter a coleção de WebPartDescription objetos em um catálogo usando o GetAvailableWebPartDescriptions método e, em seguida, exibir os detalhes de cada WebPart controle no catálogo fazendo loop pelos WebPartDescription objetos. Observe que o valor da Description propriedade é recuperado no código a seguir.

protected void Button1_Click(object sender, EventArgs e)
{
  Label1.Text = String.Empty;
  
  WebPartDescriptionCollection descriptions = 
    DeclarativeCatalogPart1.GetAvailableWebPartDescriptions();

  foreach (WebPartDescription desc in descriptions)
  {
    Label1.Text += "ID: " + desc.ID + "<br />" +
      "Title: " + desc.Title + "<br />" +
      "Description: " + desc.Description + "<br />" +
      "ImageUrl: " + desc.CatalogIconImageUrl + "<br />" +
      "<hr />";
  }
}

Protected Sub Button1_Click(ByVal sender As Object, _
  ByVal e As System.EventArgs)
  
  Label1.Text = String.Empty
      
  Dim descriptions As WebPartDescriptionCollection = _
   DeclarativeCatalogPart1.GetAvailableWebPartDescriptions()
          
  Dim desc As WebPartDescription
      
  For Each desc In descriptions
    Label1.Text += "ID: " & desc.ID & "<br />" & _
      "Title: " & desc.Title & "<br />" & _
      "Description: " & desc.Description & "<br />" & _
      "ImageUrl: " & desc.CatalogIconImageUrl & "<br />" & _
      "<hr />"
  Next
  
End Sub

Comentários

A Description propriedade corresponde diretamente à Part.Description propriedade . Se essa propriedade for definida em um WebPart controle, a propriedade no objeto correspondente WebPartDescription também terá um valor.

A Description propriedade só se aplica quando uma página está no modo de exibição de catálogo e um WebPart controle está sendo exibido em um catálogo de controles. Se o controle tiver uma descrição atribuída a ele, a descrição aparecerá no catálogo como uma Dica de Ferramenta no controle.

Confira também

• Description
• controles de Web Parts ASP.NET