DataGridColumnCollection クラス

リファレンス

定義

名前空間:: System.Web.UI.WebControls

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

重要

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

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

public ref class DataGridColumnCollection sealed : System::Collections::ICollection, System::Web::UI::IStateManager

public sealed class DataGridColumnCollection : System.Collections.ICollection, System.Web.UI.IStateManager

type DataGridColumnCollection = class
    interface ICollection
    interface IEnumerable
    interface IStateManager

Public NotInheritable Class DataGridColumnCollection
Implements ICollection, IStateManager

継承: Object
DataGridColumnCollection

実装: ICollection IEnumerable IStateManager

例

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


<%@ Page Language="C#" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
   <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>
 
<head runat="server">
    <title>DataGrid Constructor Example</title>
</head>
<body>
 
   <form id="form1" runat="server">
 
      <h3>DataGrid Constructor Example</h3>
 
      <b>Product List</b>

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


<%@ Page Language="VB" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
   <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>
 
<head runat="server">
    <title>DataGrid Constructor Example</title>
</head>
<body>
 
   <form id="form1" runat="server">
 
      <h3>DataGrid Constructor Example</h3>
 
      <b>Product List</b>

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

注釈

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

注意

プロパティが AutoGenerateColumns コントロールによってDataGrid作成された列にtrue,設定されている場合、コレクションにはColumns追加されません。

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

注意

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

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

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

Column クラス	[説明]
BoundColumn	データソース内のフィールドにバインドされている列。フィールドの各項目がテキストとして表示されます。これは、コントロールの既定の列の DataGrid 種類です。
ButtonColumn	列内の各項目のコマンドボタンを表示する列。これにより、ボタンの追加や削除などのカスタムボタンコントロールの列を作成できます。
EditCommandColumn	列内の各項目の編集コマンドを含む列。
HyperLinkColumn	列の各項目をハイパーリンクとして表示する列。列の内容は、データソース内のフィールドまたは静的テキストにバインドできます。
TemplateColumn	指定したテンプレートに従って列の各項目を表示する列。これにより、画像の表示など、列の内容を制御できます。

注意

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

コンストラクター

DataGridColumnCollection(DataGrid, ArrayList)

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

プロパティ

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

メソッド

Add(DataGridColumn)	指定した DataGridColumn の派生列オブジェクトを DataGridColumnCollection コレクションの末尾に追加します。
AddAt(Int32, DataGridColumn)	DataGridColumn コレクション内の指定したインデックス位置に、DataGridColumnCollection 派生列オブジェクトを挿入します。
Clear()	DataGridColumn コレクションからすべての DataGridColumnCollection の派生列オブジェクトを削除します。
CopyTo(Array, Int32)	指定した DataGridColumnCollection に Array コレクションの項目をコピーします。コピー操作は、Array 内の指定したインデックス位置から始まります。
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetEnumerator()	IEnumerator コレクションのすべての DataGridColumn 派生列オブジェクトを含む DataGridColumnCollection インターフェイスを返します。
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
IndexOf(DataGridColumn)	DataGridColumn コレクションの指定された DataGridColumnCollection 派生列オブジェクトのインデックスを返します。
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
Remove(DataGridColumn)	指定した DataGridColumn の派生列オブジェクトを DataGridColumnCollection コレクションから削除します。
RemoveAt(Int32)	DataGridColumn コレクションの指定したインデックス位置にある DataGridColumnCollection 派生列オブジェクトを削除します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

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

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

拡張メソッド

Cast<TResult>(IEnumerable)	IEnumerable の要素を、指定した型にキャストします。
OfType<TResult>(IEnumerable)	指定された型に基づいて IEnumerable の要素をフィルター処理します。
AsParallel(IEnumerable)	クエリの並列化を有効にします。
AsQueryable(IEnumerable)	IEnumerable を IQueryable に変換します。

適用対象