Control.ClientID プロパティ

  • [アーティクル]

ASP.NET によって生成されたサーバー コントロール ID を取得します。

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

構文

'宣言
Public Overridable ReadOnly Property ClientID As String
'使用
Dim instance As Control
Dim value As String

value = instance.ClientID

public virtual string ClientID { get; }

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

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

public function get ClientID () : String

適用できません。

プロパティ値

ASP.NET によって生成されたサーバー コントロール ID。

解説

場合によっては、コントロールに一意の名前を割り当てることができないことがあります。たとえば、Repeater コントロールにテンプレートの 1 つとして Label コントロールが含まれている場合、その Label コントロールのインスタンスが Repeater コントロールの項目ごとに表示されます。1 つのコントロールの複数のインスタンスが表示される場合、ASP.NET では、名前の競合を避けるために、1 つのページのそれぞれのサーバー コントロールに一意の ClientID 値を自動生成します。ClientID 値は、コントロールの ID 値とその親コントロールの UniqueID 値を連結することにより生成されます。コントロールの ID 値が指定されていない場合は、自動生成された値が使用されます。生成された ID の各部分はアンダースコア文字 (_) で区切られます。

メモメモ :

コントロールに対して生成された ClientID 値は UniqueID 値とほぼ同じですが、IdSeparator プロパティで指定された文字ではなく、アンダースコア文字を使用して ID 値が区切られる点が異なります。既定では、IdSeparator プロパティはコロン文字 (:) に設定されます。ClientID 値にはコロン文字が含まれないため、コロンを含む ID をサポートしない ECMAScript でこの値を使用できます。

ClientID 値は、クライアント側のスクリプトのコントロールに表示される HTML 要素にプログラムによってアクセスする場合によく使用されます。詳細については、「ASP.NET Web ページのクライアント スクリプト」を参照してください。

使用例

ページの ControlCollection オブジェクトを反復処理し、そのページ内の各コントロールの ClientID プロパティを表示する例を次に示します。

Sub Page_Load(sender As Object, e As EventArgs)
   Response.Write("<h4>Control_ClientID Sample</h4>")
   ' Get the list of all controls.
   Dim myEnumerator As IEnumerator = Controls.GetEnumerator()
   Response.Write("<br />Enumerating Controls Collection<br />")
   While myEnumerator.MoveNext()
      Dim myControl As Control = CType(myEnumerator.Current, Control)
      ' Display the ClientID property.
      Response.Write("<br />The ClientID property of Control : " & myControl.ClientID)
   End While
End Sub

void Page_Load(object sender,EventArgs e)
{
       Response.Write("<h4>Control_ClientID Sample</h4>");
       // Get the list of all controls.
      IEnumerator myEnumerator = Controls.GetEnumerator();
      Response.Write("<br />Enumerating Controls Collection<br />");    
      while(myEnumerator.MoveNext())
      {
          Control   myControl = (Control) myEnumerator.Current;
          // Display the ClientID property 
          Response.Write("<br />The ClientID property of Control : " + myControl.ClientID);
       }
 }

void Page_Load(Object sender, EventArgs e) 
{
    get_Response().Write("<h4>Control_ClientID Sample</h4>");
    
    // Get the list of all controls.
    IEnumerator myEnumerator = get_Controls().GetEnumerator();
    get_Response().Write("<br />Enumerating Controls Collection<br />");
    while(myEnumerator.MoveNext()) {
  Control myControl = (Control)(myEnumerator.get_Current());
  // Display the ClientID property 
  get_Response().Write("<br />The ClientID property of Control : " 
      + myControl.get_ClientID());
    }
} //Page_Load

プラットフォーム

Windows 98,Windows Server 2000 SP4,Windows CE,Windows Millennium Edition,Windows Mobile for Pocket PC,Windows Mobile for Smartphone,Windows Server 2003,Windows XP Media Center Edition,Windows XP Professional x64 Edition,Windows XP SP2,Windows XP Starter Edition

Microsoft .NET Framework 3.0 は Windows Vista,Microsoft Windows XP SP2,および Windows Server 2003 SP1 でサポートされています。

バージョン情報

.NET Framework

サポート対象 : 3.0,2.0,1.1,1.0

参照

関連項目

Control クラス
Control メンバ
System.Web.UI 名前空間
NamingContainer
ID
INamingContainer

その他の技術情報

ASP.NET Web ページのクライアント スクリプト