Compartir a través de

WebPartDescription.Description Propiedad

  • Referencia

Definición

Espacio de nombres:
System.Web.UI.WebControls.WebParts
Ensamblado:
System.Web.dll

Obtiene el texto de una descripción de un control WebPart.

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

Valor de propiedad

String

Una cadena que contiene la descripción de un control WebPart; el valor predeterminado es una cadena vacía ("").

Ejemplos

En el ejemplo de código siguiente se muestra el uso mediante programación de la Description propiedad . Para obtener el código completo necesario para ejecutar este ejemplo de código, consulte la sección Ejemplo del tema de información general de la WebPartDescription clase.

En el código siguiente del Button1_Click método de una página web se muestra cómo obtener la colección de objetos de WebPartDescription un catálogo mediante el GetAvailableWebPartDescriptions método y, a continuación, mostrar los detalles de cada WebPart control del catálogo mediante el bucle de los WebPartDescription objetos. Tenga en cuenta que el valor de la Description propiedad se recupera en el código siguiente.

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

Comentarios

La Description propiedad corresponde directamente a la Part.Description propiedad . Si esa propiedad se establece en un WebPart control, la propiedad del objeto correspondiente WebPartDescription también tendrá un valor.

La Description propiedad solo se aplica cuando una página está en modo de presentación de catálogo y se muestra un WebPart control en un catálogo de controles. Si el control tiene asignada una descripción, la descripción aparece en el catálogo como información sobre herramientas en el control.

Se aplica a

Consulte también