WebPartDescription.Description Özellik

Tanım

Ad Alanı:

System.Web.UI.WebControls.WebParts

Bütünleştirilmiş Kod:

System.Web.dll

Denetim için WebPart açıklama metnini alır.

public:
 property System::String ^ Description { System::String ^ get(); };

public string Description { get; }

member this.Description : string

Public ReadOnly Property Description As String

Özellik Değeri

String

Denetimin açıklamasını içeren dize WebPart ; varsayılan değer boş bir dizedir ("").

Örnekler

Aşağıdaki kod örneği, özelliğinin Description program aracılığıyla kullanımını gösterir. Bu kod örneğini çalıştırmak için gereken kodun tamamı için sınıfa genel bakış konusunun WebPartDescription Örnek bölümüne bakın.

Bir Web sayfasının yönteminde Button1_Click yer alan aşağıdaki kod, yöntemini kullanarak GetAvailableWebPartDescriptions bir katalogdaki nesne koleksiyonunun WebPartDescription nasıl alınıp nesneleri döngüye WebPartDescription alarak katalogdaki her WebPart denetimin ayrıntılarının nasıl görüntüleneceğini gösterir. Özellik değerinin Description aşağıdaki kodda alındığını unutmayın.

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

Açıklamalar

özelliği Description doğrudan Part.Description özelliğe karşılık gelir. Bu özellik bir WebPart denetimde ayarlanırsa, ilgili WebPartDescription nesnedeki özelliğin de bir değeri olur.

Description özelliği yalnızca bir sayfa katalog görüntüleme modundayken ve denetimler WebPart kataloğunda görüntüleniyorsa geçerlidir. Denetime atanmış bir açıklama varsa, açıklama katalogda denetimde Araç İpucu olarak görünür.

Ayrıca bkz.

• Description
• Web Bölümleri Denetimlerini ASP.NET