WebPartDescription.Description 屬性

  • 參考

定義

命名空間:
System.Web.UI.WebControls.WebParts
組件:
System.Web.dll

取得 WebPart 控制項的描述文字。

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

屬性值

String

包含 WebPart 控制項描述的字串；預設為空字串 ("")。

範例

下列程式碼範例示範屬性的程式 Description 設計用法。 如需執行此程式碼範例所需的完整程式碼，請參閱類別概觀主題的 WebPartDescription 範例一節。

網頁方法中的 Button1_Click 下列程式碼示範如何使用 方法來取得目錄中 GetAvailableWebPartDescriptions 的物件集合 WebPartDescription ，然後迴圈查看 物件，以顯示目錄中 WebPartDescription 每個 WebPart 控制項的詳細資料。 請注意， Description 屬性值會在下列程式碼中擷取。

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

備註

屬性 Description 會直接對應至 Part.Description 屬性。 如果在控制項上 WebPart 設定該屬性，則對應 WebPartDescription 物件中的 屬性也會有值。

只有在 Description 頁面處於目錄顯示模式，且 WebPart 控制項顯示在控制項目錄時，屬性才會套用。 如果控制項已指派描述，描述就會以控制項上的工具提示的形式出現在目錄中。

適用於

另請參閱