DataGridColumnCollection

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

DataGridColumnCollection クラス

DataGrid コントロールの列を表す DataGridColumn 派生列オブジェクトのコレクション。このクラスは継承できません。

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

Visual Basic (宣言)

Public NotInheritable Class
 DataGridColumnCollection
    Implements ICollection, IEnumerable, IStateManager

Visual Basic (使用法)

Dim instance As DataGridColumnCollection

C#

public sealed class DataGridColumnCollection
 : ICollection, IEnumerable, IStateManager

C++

public ref class DataGridColumnCollection sealed
 : ICollection, IEnumerable, IStateManager

J#

public final class DataGridColumnCollection
 implements ICollection, IEnumerable, 
    IStateManager

JScript

public final class DataGridColumnCollection
 implements ICollection, IEnumerable, 
    IStateManager

解説

DataGridColumnCollection コレクションを使用して、DataGridColumn 派生列オブジェクトのコレクションをプログラムによって管理します。これらのオブジェクトは DataGrid コントロール内の列を表します。DataGridColumnCollection コレクションに列を追加、削除、または挿入できます。

メモ
AutoGenerateColumns プロパティを true, に設定すると、DataGrid コントロールが作成した列は Columns コレクションに追加されません。

DataGrid コントロールは、その Columns コレクションの内容をビューステートには格納しません。列を動的に追加または削除するには、ページが更新されるたびにプログラムによって列を追加または削除する必要があります。DataGrid コントロールの状態を再読み込みしてコントロール自体を再度ビルドする前に、列を追加または削除する Page_Init 関数を提供します。それ以外の場合は、Columns コレクションに対する変更内容が、DataGrid コントロールが表示されるときに反映されません。

メモ
DataGrid コントロールの Columns コレクションに、プログラムによって列を追加または削除できますが、列を静的に一覧表示してから、Visible プロパティを使用して各列を表示するか、非表示にする方が簡単です。

DataGrid コントロールに列が表示される順序は、コレクションの中の列の順序によって決まります。

DataGridColumn クラスから派生したさまざまな列クラスの一覧を次の表に示します。

列のクラス	説明
BoundColumn	データ ソースのフィールドに連結されている列。各項目はフィールドにテキストとして表示されます。DataGrid コントロールの既定の列型です。
ButtonColumn	列内の各項目に関するコマンド ボタンを表示する列。この列を使用して、[Add] ボタンや [Remove] ボタンなどのカスタム ボタン コントロールの列を作成できます。
EditCommandColumn	列内の各項目に対する編集コマンドが格納されている列。
HyperLinkColumn	列内の各項目をハイパーリンクとして表示する列。列の内容は、データ ソースのフィールド、または静的テキストに連結できます。
TemplateColumn	指定されたテンプレートに従って、列内の各項目を表示する列。この列を使用して、表示イメージなどの列の内容を制御できます。

メモ
DataGridColumn クラスは、一覧表示されている列のクラスの基本クラスです。このクラスは、DataGridColumnCollection コレクションでは直接には使用されません。

使用例

DataGridColumnCollection コレクションを使用して、DataGrid コントロールに列を動的に追加する方法を次の例コードに示します。DataGrid コントロールの Columns プロパティは、DataGridColumnCollection クラスのインスタンスです。

Visual Basic

<%@ Page Language="VB" AutoEventWireup="True"
 %>
<%@ Import Namespace="System.Data"
 %>
 
<html>
   <script runat="server">

      Function CreateDataSource() As ICollection
 
      
         ' Create sample data for the DataGrid control.
         Dim dt As DataTable = New
 DataTable()
         Dim dr As DataRow
 
         ' Define the columns of the table.
         dt.Columns.Add(New DataColumn("IntegerValue",
 GetType(Int32)))
         dt.Columns.Add(New DataColumn("StringValue",
 GetType(string)))
         dt.Columns.Add(New DataColumn("CurrencyValue",
 GetType(double)))
 
         ' Populate the table with sample values.
         Dim i As Integer

         For i = 0 to 8 
        
            dr = dt.NewRow()
 
            dr(0) = i
            dr(1) = "Item " & i.ToString()
            dr(2) = 1.23 * (i + 1)
 
            dt.Rows.Add(dr)

         Next i
 
         Dim dv As DataView = New
 DataView(dt)
         Return dv

      End Function
 
      Sub Page_Load(sender As Object,
 e As EventArgs) 

         ' Create a DataGrid control.
         Dim ItemsGrid As DataGrid = New
 DataGrid()

         ' Set the properties of the DataGrid.
         ItemsGrid.ID = "ItemsGrid"
         ItemsGrid.BorderColor = System.Drawing.Color.Black
         ItemsGrid.CellPadding = 3
         ItemsGrid.AutoGenerateColumns = False

         ' Set the styles for the DataGrid.
         ItemsGrid.HeaderStyle.BackColor = System.Drawing.Color.FromArgb(&H0000aaaa)

         ' Create the columns for the DataGrid control. The DataGrid
         ' columns are dynamically generated. Therefore, the columns
   
         ' must be re-created each time the page is refreshed.
         
         ' Create and add the columns to the collection.
         ItemsGrid.Columns.Add(CreateBoundColumn("IntegerValue",
 "Item"))
         ItemsGrid.Columns.Add( _
             CreateBoundColumn("StringValue", "Description"))
         ItemsGrid.Columns.Add( _
             CreateBoundColumn("CurrencyValue", "Price",
 "{0:c}", _
             HorizontalAlign.Right))
         ItemsGrid.Columns.Add( _
             CreateLinkColumn("http:'www.microsoft.com", "_self",
 _
             "Microsoft", "Related
 link"))
        
         ' Specify the data source and bind it to the control.     
         ItemsGrid.DataSource = CreateDataSource()
         ItemsGrid.DataBind()

         ' Add the DataGrid control to the Controls collection of 
         ' the PlaceHolder control.
         Place.Controls.Add(ItemsGrid)

      End Sub

      Function CreateBoundColumn(DataFieldValue As
 String, HeaderTextValue As String)
 As BoundColumn

         ' This version of CreateBoundColumn method sets only the 
         ' DataField and HeaderText properties.

         ' Create a BoundColumn.
         Dim column As BoundColumn = New
 BoundColumn()

         ' Set the properties of the BoundColumn.
         column.DataField = DataFieldValue
         column.HeaderText = HeaderTextValue

         Return column

      End Function

      Function CreateBoundColumn(DataFieldValue As
 String, _
          HeaderTextValue As String, FormatValue
 As String, _
          AlignValue As HorizontalAlign) As
 BoundColumn

         ' This version of CreateBoundColumn method sets the DataField
,
         ' HeaderText, and DataFormatString properties. It also sets
 the 
         ' HorizontalAlign property of the ItemStyle property of the
 column. 

         ' Create a BoundColumn using the overloaded CreateBoundColumn
 method.
         Dim column As BoundColumn = CreateBoundColumn(DataFieldValue,
 HeaderTextValue)

         ' Set the properties of the BoundColumn.
         column.DataFormatString = FormatValue
         column.ItemStyle.HorizontalAlign = AlignValue

         Return column

      End Function

      Function CreateLinkColumn(NavUrlValue As
 String, TargetValue As String,
 _
         TextValue As String, HeaderTextValue
 As String) As HyperLinkColumn
 

         ' Create a BoundColumn.
         Dim column As HyperLinkColumn = New
 HyperLinkColumn()

         ' Set the properties of the ButtonColumn.
         column.NavigateUrl = NavUrlValue
         column.Target = TargetValue
         column.Text = TextValue
         column.HeaderText = HeaderTextValue

         Return column

      End Function

   </script>
 
<body>
 
   <form runat=server>
 
      <h3>DataGrid Constructor Example</h3>
 
      <b>Product List</b>

      <asp:PlaceHolder id="Place"
           runat="server"/>
 
   </form>
 
</body>
</html>

C#

<%@ Page Language="C#" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>
 
<html>
   <script runat="server">

      ICollection CreateDataSource() 
      {
      
         // Create sample data for the DataGrid control.
         DataTable dt = new DataTable();
         DataRow dr;
 
         // Define the columns of the table.
         dt.Columns.Add(new DataColumn("IntegerValue",
 typeof(Int32)));
         dt.Columns.Add(new DataColumn("StringValue",
 typeof(string)));
         dt.Columns.Add(new DataColumn("CurrencyValue",
 typeof(double)));
 
         // Populate the table with sample values.
         for (int i = 0; i < 9; i++) 
         {
            dr = dt.NewRow();
 
            dr[0] = i;
            dr[1] = "Item " + i.ToString();
            dr[2] = 1.23 * (i + 1);
 
            dt.Rows.Add(dr);
         }
 
         DataView dv = new DataView(dt);
         return dv;

      }
 
      void Page_Load(Object sender, EventArgs e) 
      {

         // Create a DataGrid control.
         DataGrid ItemsGrid = new DataGrid();

         // Set the properties of the DataGrid.
         ItemsGrid.ID = "ItemsGrid";
         ItemsGrid.BorderColor = System.Drawing.Color.Black;
         ItemsGrid.CellPadding = 3;
         ItemsGrid.AutoGenerateColumns = false;

         // Set the styles for the DataGrid.
         ItemsGrid.HeaderStyle.BackColor = 
             System.Drawing.Color.FromArgb(0x0000aaaa);

         // Create the columns for the DataGrid control. The DataGrid
         // columns are dynamically generated. Therefore, the columns
   
         // must be re-created each time the page is refreshed.
         
         // Create and add the columns to the collection.
         ItemsGrid.Columns.Add(CreateBoundColumn("IntegerValue", "Item"));
         ItemsGrid.Columns.Add(
             CreateBoundColumn("StringValue", "Description"));
         ItemsGrid.Columns.Add(
             CreateBoundColumn("CurrencyValue", "Price", "{0:c}",
 
             HorizontalAlign.Right));
         ItemsGrid.Columns.Add(
             CreateLinkColumn("http://www.microsoft.com",
 "_self", 
             "Microsoft", "Related link"));
        
         // Specify the data source and bind it to the control.
         ItemsGrid.DataSource = CreateDataSource();
         ItemsGrid.DataBind();

         // Add the DataGrid control to the Controls collection of 
         // the PlaceHolder control.
         Place.Controls.Add(ItemsGrid);

      }

      BoundColumn CreateBoundColumn(String DataFieldValue, 
          String HeaderTextValue)
      {

         // This version of the CreateBoundColumn method sets only the
         // DataField and HeaderText properties.

         // Create a BoundColumn.
         BoundColumn column = new BoundColumn();

         // Set the properties of the BoundColumn.
         column.DataField = DataFieldValue;
         column.HeaderText = HeaderTextValue;

         return column;

      }

      BoundColumn CreateBoundColumn(String DataFieldValue, 
          String HeaderTextValue, String FormatValue, 
          HorizontalAlign AlignValue)
      {

         // This version of CreateBoundColumn method sets the DataField
,
         // HeaderText, and DataFormatString properties. It also sets
 the 
         // HorizontalAlign property of the ItemStyle property of the
 column. 

         // Create a BoundColumn using the overloaded CreateBoundColumn
 method.
         BoundColumn column = CreateBoundColumn(DataFieldValue, HeaderTextValue);

         // Set the properties of the BoundColumn.
         column.DataFormatString = FormatValue;
         column.ItemStyle.HorizontalAlign = AlignValue;

         return column;

      }

      HyperLinkColumn CreateLinkColumn(String NavUrlValue, 
          String TargetValue, String TextValue, String HeaderTextValue)
      {

         // Create a BoundColumn.
         HyperLinkColumn column = new HyperLinkColumn();

         // Set the properties of the ButtonColumn.
         column.NavigateUrl = NavUrlValue;
         column.Target = TargetValue;
         column.Text = TextValue;
         column.HeaderText = HeaderTextValue;

         return column;

      }

   </script>
 
<body>
 
   <form runat=server>
 
      <h3>DataGrid Constructor Example</h3>
 
      <b>Product List</b>

      <asp:PlaceHolder id="Place"
           runat="server"/>
 
   </form>
 
</body>
</html>

継承階層

System.Object
  System.Web.UI.WebControls.DataGridColumnCollection

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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、1.1、1.0

参照

関連項目
DataGridColumnCollection メンバ
System.Web.UI.WebControls 名前空間
DataGrid クラス
DataGrid.Columns プロパティ
DataGridColumn クラス
BoundColumn クラス
ButtonColumn クラス
EditCommandColumn
HyperLinkColumn
TemplateColumn

DataGridColumnCollection コンストラクタ

DataGridColumnCollection クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    owner As DataGrid, _
    columns As ArrayList _
)

Visual Basic (使用法)

Dim owner As DataGrid
Dim columns As ArrayList

Dim instance As New DataGridColumnCollection(owner,
 columns)

C#

public DataGridColumnCollection (
    DataGrid owner,
    ArrayList columns
)

C++

public:
DataGridColumnCollection (
    DataGrid^ owner, 
    ArrayList^ columns
)

J#

public DataGridColumnCollection (
    DataGrid owner, 
    ArrayList columns
)

JScript

public function DataGridColumnCollection (
    owner : DataGrid, 
    columns : ArrayList
)

パラメータ

owner

このコレクションに対応する DataGrid コントロール。

columns

列のコレクションを格納する System.Collections.ArrayList。

解説

このコンストラクタを使用して、DataGridColumnCollection クラスの新しいインスタンスを作成し、初期化します。

使用例

DataGridColumnCollection クラスの新しいインスタンスを作成および初期化する方法を次のコード例に示します。

Visual Basic

Sub Page_Init(sender As Object,
 e As EventArgs)
    Dim myList As New ArrayList()
    Dim myColumnCollection As New
 DataGridColumnCollection(ItemsGrid, myList)
End Sub 'Page_Init

C#

void Page_Init(Object sender, EventArgs e) 
{
   ArrayList myList = new ArrayList();
   DataGridColumnCollection myColumnCollection = new DataGridColumnCollection(ItemsGrid,
 myList); 
}
   

J#

void Page_Init(Object sender, EventArgs e)
{
    ArrayList myList = new ArrayList();
    DataGridColumnCollection myColumnCollection = 
        new DataGridColumnCollection(itemsGrid, myList);
} //Page_Init

プラットフォーム

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、1.1、1.0

参照

関連項目
DataGridColumnCollection クラス
DataGridColumnCollection メンバ
System.Web.UI.WebControls 名前空間
DataGrid クラス
System.Collections.ArrayList

DataGridColumnCollection プロパティ

パブリック プロパティ

	名前	説明
	Count	DataGridColumnCollection コレクション内の列の数を取得します。
	IsReadOnly	DataGridColumnCollection コレクション内の列を変更できるかどうかを示す値を取得します。
	IsSynchronized	DataGridColumnCollection コレクションへのアクセスが同期されている (スレッド セーフである) かどうかを示す値を取得します。
	Item	DataGridColumnCollection コレクションの指定したインデックス位置にある DataGridColumn 派生列オブジェクトを取得します。
	SyncRoot	DataGridColumnCollection コレクションへのアクセスを同期するために使用できるオブジェクトを取得します。

明示的インターフェイスの実装

	名前	説明
	System.Web.UI.IStateManager.IsTrackingViewState	コレクションがビューステートの変更を追跡しているかどうかを示す値を取得します。

参照

関連項目

DataGridColumnCollection クラス
System.Web.UI.WebControls 名前空間
DataGrid クラス
DataGrid.Columns プロパティ
DataGridColumn クラス
BoundColumn クラス
ButtonColumn クラス
EditCommandColumn
HyperLinkColumn
TemplateColumn

DataGridColumnCollection メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Add	指定した DataGridColumn の派生列オブジェクトを DataGridColumnCollection コレクションの末尾に追加します。
	AddAt	DataGridColumnCollection コレクション内の指定したインデックス位置に、DataGridColumn 派生列オブジェクトを挿入します。
	Clear	DataGridColumnCollection コレクションからすべての DataGridColumn の派生列オブジェクトを削除します。
	CopyTo	指定した System.Array に DataGridColumnCollection コレクションの項目をコピーします。コピー操作は、System.Array 内の指定したインデックス位置から始まります。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetEnumerator	DataGridColumnCollection コレクションのすべての DataGridColumn 派生列オブジェクトを含む System.Collections.IEnumerator インターフェイスを返します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IndexOf	DataGridColumnCollection コレクションの指定された DataGridColumn 派生列オブジェクトのインデックスを返します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	Remove	指定した DataGridColumn の派生列オブジェクトを DataGridColumnCollection コレクションから削除します。
	RemoveAt	DataGridColumnCollection コレクションの指定したインデックス位置にある DataGridColumn 派生列オブジェクトを削除します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

明示的インターフェイスの実装

	名前	説明
	System.Web.UI.IStateManager.LoadViewState	以前に保存した状態を読み込みます。
	System.Web.UI.IStateManager.SaveViewState	状態の変化を示すオブジェクトを返します。
	System.Web.UI.IStateManager.TrackViewState	状態変化の追跡を開始します。

参照

関連項目

DataGridColumnCollection クラス
System.Web.UI.WebControls 名前空間
DataGrid クラス
DataGrid.Columns プロパティ
DataGridColumn クラス
BoundColumn クラス
ButtonColumn クラス
EditCommandColumn
HyperLinkColumn
TemplateColumn

DataGridColumnCollection メンバ

DataGrid コントロールの列を表す DataGridColumn 派生列オブジェクトのコレクション。このクラスは継承できません。

DataGridColumnCollection データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	DataGridColumnCollection	DataGridColumnCollection クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	Count	DataGridColumnCollection コレクション内の列の数を取得します。
	IsReadOnly	DataGridColumnCollection コレクション内の列を変更できるかどうかを示す値を取得します。
	IsSynchronized	DataGridColumnCollection コレクションへのアクセスが同期されている (スレッド セーフである) かどうかを示す値を取得します。
	Item	DataGridColumnCollection コレクションの指定したインデックス位置にある DataGridColumn 派生列オブジェクトを取得します。
	SyncRoot	DataGridColumnCollection コレクションへのアクセスを同期するために使用できるオブジェクトを取得します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Add	指定した DataGridColumn の派生列オブジェクトを DataGridColumnCollection コレクションの末尾に追加します。
	AddAt	DataGridColumnCollection コレクション内の指定したインデックス位置に、DataGridColumn 派生列オブジェクトを挿入します。
	Clear	DataGridColumnCollection コレクションからすべての DataGridColumn の派生列オブジェクトを削除します。
	CopyTo	指定した System.Array に DataGridColumnCollection コレクションの項目をコピーします。コピー操作は、System.Array 内の指定したインデックス位置から始まります。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetEnumerator	DataGridColumnCollection コレクションのすべての DataGridColumn 派生列オブジェクトを含む System.Collections.IEnumerator インターフェイスを返します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IndexOf	DataGridColumnCollection コレクションの指定された DataGridColumn 派生列オブジェクトのインデックスを返します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	Remove	指定した DataGridColumn の派生列オブジェクトを DataGridColumnCollection コレクションから削除します。
	RemoveAt	DataGridColumnCollection コレクションの指定したインデックス位置にある DataGridColumn 派生列オブジェクトを削除します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

明示的インターフェイスの実装

	名前	説明
	System.Web.UI.IStateManager.LoadViewState	以前に保存した状態を読み込みます。
	System.Web.UI.IStateManager.SaveViewState	状態の変化を示すオブジェクトを返します。
	System.Web.UI.IStateManager.TrackViewState	状態変化の追跡を開始します。
	System.Web.UI.IStateManager.IsTrackingViewState	コレクションがビューステートの変更を追跡しているかどうかを示す値を取得します。

参照

関連項目

DataGridColumnCollection クラス
System.Web.UI.WebControls 名前空間
DataGrid クラス
DataGrid.Columns プロパティ
DataGridColumn クラス
BoundColumn クラス
ButtonColumn クラス
EditCommandColumn
HyperLinkColumn
TemplateColumn