Control.UniqueID プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

Control.UniqueID プロパティ

階層構造で修飾されたサーバーコントロールの一意の ID を取得します。

名前空間: System.Web.UI
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Overridable ReadOnly
 Property UniqueID As String

Visual Basic (使用法)

Dim instance As Control
Dim value As String

value = instance.UniqueID

public virtual string UniqueID { get;
 }

C++

public:
virtual property String^ UniqueID {
    String^ get ();
}

/** @property */
public String get_UniqueID ()

JScript

public function get UniqueID
 () : String

プロパティ値
サーバーコントロールの完全修飾 ID。

解説

UniqueID プロパティにはサーバーコントロールの名前付けコンテナが含まれている点で、このプロパティは ID プロパティとは異なります。この ID は、ページ要求が処理されると自動的に生成されます。

このプロパティは、繰り返されるデータバインディングサーバーコントロールの中に含まれているサーバーコントロールを区別する場合に、特に重要です。連続コントロールである Repeater、DataList、DataGrid の各 Web サーバーコントロール (またはデータ連結されたときに繰り返し機能を含めて作成したカスタムサーバーコントロール) は、子コントロールの名前付けコンテナとして機能します。したがって、ID プロパティ値が競合しないように、子コントロールの一意の名前空間が作成されます。

たとえば、Repeater サーバーコントロールに ASP.NET Label Web サーバーコントロールを含める場合は、Label コントロールに MyLabel の ID プロパティ値を割り当て、さらに Repeater に MyRepeater の ID プロパティ値を割り当てます。Repeater へのデータを、3 つのエントリを持つ ArrayList オブジェクトにバインドした場合、結果として取得される Label サーバーコントロールの各インスタンスの UniqueID プロパティは、MyRepeater:ctl0:MyLabel、MyRepeater:Ctl1:MyLabel、および MyRepeater:Ctl2:MyLabel となります。

使用例

ArrayList オブジェクトを作成して 3 つのテキスト文字列をそのオブジェクトに設定し、ページの読み込み時に ArrayList のデータを Repeater Web サーバーコントロールにバインドする例を次に示します。ユーザーが Button1_Click メソッドに関連付けられているボタンをクリックすると、DataBind メソッドが呼び出されたときに追加された Repeater の子コントロールごとに UniqueID プロパティが取得されます。

Visual Basic

Private Sub Page_Load(sender As
 Object, e As EventArgs)
   ' Intialise ArrayList.
   Dim myArray As New ArrayList()
   myArray.Add("Hello")
   myArray.Add("World")
   myArray.Add("!")

   ' Bind ArrayList to Repeater control.
   Repeater1.DataSource = myArray
   Repeater1.DataBind()
End Sub

Private Sub Button1_Click(sender As
 Object, e As EventArgs)
   Dim i As Integer
   For i = 0 To Repeater1.Controls.Count -
 1
      Response.Write("<br>")
      Response.Write(Repeater1.Controls(i).UniqueID)
   Next i
End Sub

private void Page_Load(object sender, EventArgs
 e)
{
   // Intialise ArrayList.
   ArrayList myArray = new ArrayList();
   myArray.Add("Hello");
   myArray.Add("World");
   myArray.Add("!");

   // Bind ArrayList to Repeater control.
   Repeater1.DataSource = myArray;
   Repeater1.DataBind();
}

private void Button1_Click(object sender, EventArgs
 e)
{
   for (int i=0; i<Repeater1.Controls.Count;
 i++)
   {
      Response.Write("<br>");
      Response.Write(Repeater1.Controls[i].UniqueID);
   }
}

private void Page_Load(Object sender, EventArgs
 e)
{
    // Intialise ArrayList.
    ArrayList myArray =  new ArrayList();
    myArray.Add("Hello");
    myArray.Add("World");
    myArray.Add("!");

    // Bind ArrayList to Repeater control.
    Repeater1.set_DataSource(myArray);
    Repeater1.DataBind();
} //Page_Load

private void Button1_Click(Object sender, EventArgs
 e) 
{
    for(int i=0;i < Repeater1.get_Controls().get_Count();i++)
 {
        get_Response().Write("<br>");
        get_Response().Write(
            Repeater1.get_Controls().get_Item(i).get_UniqueID());
    } 
} //Button1_Click