次の方法で共有


WebPartDescription.ID プロパティ

定義

対応する WebPart コントロールの ID を取得します。

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

プロパティ値

コントロールの ID を含む文字列。

次のコード例は、 ID プロパティのプログラムによる使用を示しています。 このコード例を実行するために必要な完全なコードについては、「 WebPartDescription クラスの概要」トピックの「例」セクションを参照してください。

Web ページの Button1_Click メソッドの次のコードは、GetAvailableWebPartDescriptions メソッドを使用してカタログ内のWebPartDescription オブジェクトのコレクションを取得し、WebPartDescription オブジェクトをループ処理してカタログ内の各WebPart コントロールの詳細を表示する方法を示しています。 ID プロパティの値は、次のコードで取得されることに注意してください。

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

注釈

ID プロパティの値をnullすることはできません。常に値を持つ必要があります。 ID プロパティは、Control.ID プロパティに直接対応します。

ID プロパティは、ページがカタログ表示モードで、WebPart コントロールがコントロールのカタログに表示されている場合にのみ適用されます。

適用対象

こちらもご覧ください