GridView.Columns プロパティ

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

GridView.Columns プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

GridView コントロールの列フィールドを表す DataControlField オブジェクトのコレクションを取得します。

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

Visual Basic (宣言)

Public Overridable ReadOnly
 Property Columns As DataControlFieldCollection

Visual Basic (使用法)

Dim instance As GridView
Dim value As DataControlFieldCollection

value = instance.Columns

C#

public virtual DataControlFieldCollection Columns { get;
 }

C++

public:
virtual property DataControlFieldCollection^ Columns {
    DataControlFieldCollection^ get ();
}

J#

/** @property */
public DataControlFieldCollection get_Columns ()

JScript

public function get Columns
 () : DataControlFieldCollection

プロパティ値
GridView コントロール内のすべての列フィールドが格納された DataControlFieldCollection。

解説

列フィールドは、GridView コントロールの列を表します。Columns プロパティ (コレクション) を使用して、GridView コントロールに表示される明示的に宣言されたすべての列フィールドが格納されます。Columns コレクションを使用して、プログラムによって列フィールドのコレクションを管理することもできます。

メモ
明示的に宣言された列フィールドは、自動生成された列フィールドと組み合わせて使用できます。これらの両方を使用した場合、明示的に宣言された列フィールドが先に表示され、自動生成された列フィールドが次に表示されます。自動生成された列フィールドは、Columns コレクションに追加されません。

列フィールドは、Columns コレクションでの列フィールドの表示順で GridView コントロールに表示されます。DataControlField クラスから派生し、Columns コレクションで使用できるさまざまな列フィールド クラスの一覧を次の表に示します。

列フィールド型	説明
BoundField	データ ソースのフィールドの値を表示します。この型は GridView コントロールの既定の列型です。
ButtonField	GridView コントロールの各項目に対してコマンド ボタンを表示します。この機能により、[Add] ボタンや [Remove] ボタンなどのカスタム ボタン コントロールの列を作成できます。
CheckBoxField	GridView コントロールの各項目に対してチェック ボックスを表示します。この列フィールド型は、通常、ブール値を持つフィールドの表示に使用されます。
CommandField	定義済みのコマンド ボタンを表示して、選択、編集、または削除の各操作を実行します。
HyperLinkField	データ ソース内のフィールドの値をハイパーリンクとして表示します。この列フィールド型を使用すると、2 番目のフィールドをハイパーリンクの URL にバインドできます。
ImageField	GridView コントロールの各項目に対してイメージを表示します。
TemplateField	指定したテンプレートに基づいて、GridView コントロールの各項目に対してユーザー定義のコンテンツを表示します。この列フィールド型を使用すると、カスタムの列フィールドを作成できます。

プログラムによって Columns コレクションに列フィールドを追加することもできますが、宣言によって GridView コントロールの列フィールドを指定し、各列フィールドの Visible プロパティを使用して各列フィールドの表示と非表示を切り替えた方が簡単です。

列フィールドの Visible プロパティが false に設定されている場合、その列は GridView コントロールに表示されず、列のデータはクライアントへのラウンド トリップを行いません。表示されない列のデータをラウンド トリップさせる場合は、そのフィールド名を DataKeyNames プロパティに追加します。

使用例

宣言によって Columns コレクションを設定する方法を次のコード例に示します。

Visual Basic

<%@ Page language="VB" %>

<html>
  <body>
    <form runat="server">
        
      <h3>GridView Columns Example</h3>

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        runat="server">
        
        <columns>
          <asp:boundfield datafield="CustomerID"
 headertext="Customer ID"/>
          <asp:boundfield datafield="CompanyName"
 headertext="Company Name"/>
          <asp:boundfield datafield="Address" headertext="Address"/>
          <asp:boundfield datafield="City" headertext="City"/>
          <asp:boundfield datafield="PostalCode"
 headertext="Postal Code"/>
          <asp:boundfield datafield="Country" headertext="Country"/>
        </columns>
                
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects
  -->
      <!-- to the Northwind sample database. Use an ASP.NET
     -->
      <!-- expression to retrieve the connection string
 value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address],
 [City], [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
 
        runat="server"/>
        
    </form>
  </body>
</html>

C#

<%@ Page language="C#" %>

<html>
  <body>
    <form runat="server">
        
      <h3>GridView Columns Example</h3>

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        runat="server">
        
        <columns>
          <asp:boundfield datafield="CustomerID" headertext="Customer
 ID"/>
          <asp:boundfield datafield="CompanyName" headertext="Company
 Name"/>
          <asp:boundfield datafield="Address" headertext="Address"/>
          <asp:boundfield datafield="City" headertext="City"/>
          <asp:boundfield datafield="PostalCode" headertext="Postal
 Code"/>
          <asp:boundfield datafield="Country" headertext="Country"/>
        </columns>
                
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value
   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City],
 [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
 
        runat="server"/>
        
    </form>
  </body>
</html>

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
GridView クラス
GridView メンバ
System.Web.UI.WebControls 名前空間
BoundField クラス
ButtonField クラス
CheckBoxField クラス
CommandField クラス
DataControlFieldCollection クラス
HyperLinkField
ImageField
TemplateField
GridView.AutoGenerateColumns プロパティ