WebPartDescription.Description Eigenschaft

  • Referenz

Definition

Namespace:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Ruft den Text einer Beschreibung für ein WebPart-Steuerelement ab.

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

Eigenschaftswert

String

Eine Zeichenfolge mit der Beschreibung für ein WebPart-Steuerelement. Der Standardwert ist eine leere Zeichenfolge ("").

Beispiele

Im folgenden Codebeispiel wird die programmgesteuerte Verwendung der Description Eigenschaft veranschaulicht. Den vollständigen Code, der zum Ausführen dieses Codebeispiels erforderlich ist, finden Sie im Abschnitt "Beispiel" des Abschnitts " WebPartDescription Klassenübersicht".

Der folgende Code in der Button1_Click Methode einer Webseite veranschaulicht, wie sie die Auflistung von WebPartDescription Objekten in einem Katalog mithilfe der GetAvailableWebPartDescriptions Methode abrufen und dann die Details der einzelnen WebPart Steuerelemente im Katalog anzeigen, indem Sie die WebPartDescription Objekte durchlaufen. Beachten Sie, dass der Description Eigenschaftswert im folgenden Code abgerufen wird.

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

Hinweise

Die Description Eigenschaft entspricht direkt der Part.Description Eigenschaft. Wenn diese Eigenschaft für ein WebPart Steuerelement festgelegt ist, weist die Eigenschaft im entsprechenden WebPartDescription Objekt auch einen Wert auf.

Die Description Eigenschaft gilt nur, wenn sich eine Seite im Kataloganzeigemodus befindet und ein WebPart Steuerelement in einem Katalog von Steuerelementen angezeigt wird. Wenn dem Steuerelement eine Beschreibung zugewiesen ist, wird die Beschreibung im Katalog als QuickInfo für das Steuerelement angezeigt.

Gilt für

Siehe auch