WebPartDescription.Description Egenskap

Definition

Namnområde:
System.Web.UI.WebControls.WebParts
Sammansättning:
System.Web.dll

Hämtar texten i en beskrivning för en WebPart kontroll.

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

Egenskapsvärde

String

En sträng som innehåller beskrivningen för en WebPart kontroll. Standardvärdet är en tom sträng ("").

Exempel

I följande kodexempel visas programmatisk användning av Description egenskapen. Fullständig kod som krävs för att köra det här kodexemplet finns i avsnittet Exempel i WebPartDescription avsnittet klassöversikt.

Följande kod i Button1_Click metoden för en webbsida visar hur du hämtar samlingen av objekt i en katalog med hjälp WebPartDescription av GetAvailableWebPartDescriptions metoden och sedan visar information om varje WebPart kontroll i katalogen genom att loopa igenom objektenWebPartDescription. Observera att egenskapsvärdet Description hämtas i följande kod.

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

Kommentarer

Egenskapen Description motsvarar egenskapen direkt Part.Description . Om egenskapen har angetts för en WebPart kontroll har egenskapen i motsvarande WebPartDescription objekt också ett värde.

Egenskapen Description gäller endast när en sida är i katalogvisningsläge och en WebPart kontroll visas i en katalog med kontroller. Om kontrollen har tilldelats en beskrivning visas beskrivningen i katalogen som en knappbeskrivning för kontrollen.

Gäller för

Se även