WebPartDescription.Description Propriedade

Definição

Espaço de Nomes:
System.Web.UI.WebControls.WebParts
Assemblagem:
System.Web.dll

Recebe o texto de uma descrição para um WebPart controlo.

public:
 property System::String ^ Description { System::String ^ get(); };
public string Description { get; }
member this.Description : string
Public ReadOnly Property Description As String

Valor de Propriedade

String

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

Exemplos

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

O código seguinte no Button1_Click método de uma página Web demonstra como obter a coleção de WebPartDescription objetos num catálogo usando o GetAvailableWebPartDescriptions método, e depois mostrar os detalhes de cada WebPart controlo no catálogo percorrendo os WebPartDescription objetos. Note que o valor da Description propriedade é recuperado no código seguinte.

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

Observações

A Description propriedade corresponde diretamente à propriedade Part.Description . Se essa propriedade estiver definida num WebPart controlo, então a propriedade no objeto correspondente WebPartDescription também terá um valor.

A Description propriedade aplica-se apenas quando uma página está em modo de visualização de catálogo e um WebPart controlo está a ser exibido num catálogo de controlos. Se o controlo tiver uma descrição atribuída, a descrição aparece no catálogo como uma ToolTip no controlo.

Aplica-se a

Ver também