Share via

WebPartDescription.Description Propriété

  • Référence

Définition

Espace de noms:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Obtient le texte de description d'un contrôle WebPart.

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

Valeur de propriété

String

Chaîne qui contient la description d'un contrôle WebPart ; la valeur par défaut est une chaîne vide ("").

Exemples

L’exemple de code suivant illustre l’utilisation programmatique de la Description propriété. Pour obtenir le code complet requis pour exécuter cet exemple de code, consultez la section Exemple de la rubrique vue d’ensemble de la WebPartDescription classe.

Le code suivant dans la Button1_Click méthode d’une page Web montre comment obtenir la collection d’objets d’un catalogue à l’aide de WebPartDescription la GetAvailableWebPartDescriptions méthode, puis pour afficher les détails de chaque WebPart contrôle dans le catalogue en effectuant une boucle dans les WebPartDescription objets. Notez que la valeur de propriété Description est récupérée dans le code suivant.

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

Remarques

La Description propriété correspond directement à la Part.Description propriété. Si cette propriété est définie sur un WebPart contrôle, la propriété de l’objet correspondant WebPartDescription aura également une valeur.

La Description propriété s’applique uniquement lorsqu’une page est en mode d’affichage catalogue et qu’un WebPart contrôle est affiché dans un catalogue de contrôles. Si la description du contrôle lui est affectée, la description apparaît dans le catalogue sous la forme d’une info-bulle sur le contrôle.

S’applique à

Voir aussi