Control.ClientIDMode プロパティ

リファレンス

定義

名前空間:: System.Web.UI

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ClientID プロパティの値を生成するために使用されるアルゴリズムを取得または設定します。

public:
 virtual property System::Web::UI::ClientIDMode ClientIDMode { System::Web::UI::ClientIDMode get(); void set(System::Web::UI::ClientIDMode value); };

[System.Web.UI.Themeable(false)]
public virtual System.Web.UI.ClientIDMode ClientIDMode { get; set; }

[<System.Web.UI.Themeable(false)>]
member this.ClientIDMode : System.Web.UI.ClientIDMode with get, set

Public Overridable Property ClientIDMode As ClientIDMode

プロパティ値

ClientIDMode

ClientID プロパティの生成方法を示す値。既定値は、Inherit です。

属性: ThemeableAttribute

例

次の例は、コントロールに含まれるコントロールをListView示していますLabel。コントロールでは、 ListView ClientIDMode プロパティはに Predictable 設定され、 ClientIDRowSuffix プロパティはに ProductID設定されます。レンダリングされた HTML では、3 つのコントロールに対応する 3 つのspanProductIDLabel要素が作成されます。ページを実行すると、要素のidspan属性は次の値に設定されます。

ListView1_ProductIDLabel_1
ListView1_ProductIDLabel_34
ListView1_ProductIDLabel_43

<asp:XmlDataSource ID="XmlDataSource1" runat="server" 
                   XPath="Products/Product">
  <Data>
    <Products>
      <Product ProductID="1"  ProductName="Chai" />
      <Product ProductID="34" ProductName="Ale" />
      <Product ProductID="43" ProductName="Coffee" />
    </Products>
  </Data>
</asp:XmlDataSource>

<asp:ListView ID="ListView1" 
              ClientIDMode="Predictable" 
              ClientIDRowSuffix="ProductID"  
              DataSourceID="XmlDataSource1" runat="server" >
  <ItemTemplate>
    ProductID: 
    <asp:Label ID="ProductIDLabel" runat="server" 
               Text='<%# Eval("ProductID") %>' />
    <br />
    ProductName:
    <asp:Label ID="ProductNameLabel" runat="server" 
               Text='<%# Eval("ProductName") %>' />
    <br />
    <br />
  </ItemTemplate>

  <LayoutTemplate>
    <div ID="itemPlaceholderContainer" runat="server">
      <span ID="itemPlaceholder" runat="server" />
    </div>
    <div>
    </div>
  </LayoutTemplate>
  
</asp:ListView>

注釈

ASP.NET には、プロパティ値を生成する方法に関する複数のアルゴリズムが ClientID 用意されています。コントロールに使用するアルゴリズムを選択するには、そのプロパティを ClientIDMode 設定します。アルゴリズムは、次の表に ClientIDMode 示す列挙値によって識別されます。

値	説明
AutoID	ClientID 値は、それぞれの親名前付けコンテナーの ID 値とコントロールの ID 値を連結することにより生成されます。コントロールの複数のインスタンスが表示されるデータバインディングシナリオでは、コントロールの ID 値の前にインクリメント値が挿入されます。各セグメントはアンダースコア文字 (_) で区切られます。このアルゴリズムは、ASP.NET 4 より前のバージョンの ASP.NET で使用されました。
Static	ClientID 値は、ID プロパティの値に設定されます。コントロールが名前付けコンテナーの場合、そのコントロールは、名前付けコンテナーの階層構造に含まれるすべてのコントロールに対して最上位の階層として使用されます。
Predictable	このアルゴリズムは、データバインドコントロール内のコントロールに対して使用されます。 ClientID 値は、親名前付けコンテナーの ClientID 値とコントロールの ID 値を連結することにより生成されます。コントロールが複数の行を生成するデータバインドコントロールである場合は、ClientIDRowSuffix プロパティで指定されたデータフィールドの値が末尾に追加されます。 GridView コントロールの場合は、複数のデータフィールドを指定できます。プロパティが ClientIDRowSuffix 空白の場合は、データフィールド値ではなく、末尾に連続する数値が追加されます。この数値は 0 から始まり、各行に対して 1 ずつインクリメントされます。各セグメントはアンダースコア文字 (_) で区切られます。
Inherit	コントロールは、ClientIDMode コントロールの NamingContainer 設定を継承します。

ページの ClientIDMode 既定値はです Predictable。コントロールの ClientIDMode 既定値はです Inherit。コントロールの既定値は Inheritであるため、既定の生成モードはです Predictable。 (ただし、Visual Studio を使用して Web プロジェクトを以前のバージョンから ASP.NET 4 に変換する場合、Visual Studio では、Web.config ファイルでサイトの既定値が自動的にに AutoID 設定されます)。

詳細については、ASP.NET Web サーバーコントロールの識別に関する記事をご覧ください。

適用対象

次の方法で共有

Control.ClientIDMode プロパティ

定義

プロパティ値

例

注釈

適用対象

こちらもご覧ください

その他のリソース