TemplateColumn TemplateColumn TemplateColumn TemplateColumn Class

定義

列内のコントロールのレイアウトをカスタマイズすることができる DataGrid コントロールの列型を表します。Represents a column type for the DataGrid control that allows you to customize the layout of controls in the column.

public ref class TemplateColumn : System::Web::UI::WebControls::DataGridColumn
public class TemplateColumn : System.Web.UI.WebControls.DataGridColumn
type TemplateColumn = class
    inherit DataGridColumn
Public Class TemplateColumn
Inherits DataGridColumn
継承
TemplateColumnTemplateColumnTemplateColumnTemplateColumn

TemplateColumnクラスを使用して、カスタムレイアウトを持つDataGridコントロールに列を作成する方法を次のコード例に示します。The following code example demonstrates how to use the TemplateColumn class to create a column in the DataGrid control with a custom layout.


<%@ 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">

      DataTable Store = new DataTable();
      DataView StoreView;  

      void Page_Load(Object sender, EventArgs e) 
      {
         if(Session["StoreData"] == null)
         {
            DataRow dr;
 
            Store = new DataTable();      

            Store.Columns.Add(new DataColumn("Tax", typeof(String)));
            Store.Columns.Add(new DataColumn("Item", typeof(String)));
            Store.Columns.Add(new DataColumn("Price", typeof(String)));

            Session["StoreData"] = Store;
            
            // Create sample data.
            for (int i = 1; i <= 4; i++) 
            {
               dr = Store.NewRow();

               dr[0] = "0.0%";
               dr[1] = "Item " + i.ToString();
               dr[2] = (1.23 * (i + 1)).ToString();
 
               Store.Rows.Add(dr);
            }       

         }
         else
            Store = (DataTable)Session["StoreData"];

         StoreView = new DataView(Store);
         StoreView.Sort="Item";

         if(!IsPostBack)                    
            BindGrid();
                   
      }

      void MyDataGrid_Edit(Object sender, DataGridCommandEventArgs e) 
      {
         MyDataGrid.EditItemIndex = e.Item.ItemIndex;
         BindGrid();
      }

      void MyDataGrid_Cancel(Object sender, DataGridCommandEventArgs e) 
      {
         MyDataGrid.EditItemIndex = -1;
         BindGrid();
      }

      void MyDataGrid_Update(Object sender, DataGridCommandEventArgs e) 
      {
         // Get the text box that contains the price to edit. 
         // For bound columns the edited value is stored in a text box.
         // The text box is the first control in the Controls collection.
         TextBox priceText = (TextBox)e.Item.Cells[3].Controls[0];

         // Get the check box that indicates whether to include tax from the 
         // TemplateColumn. Notice that in this case, the check box control is
         // second control in the Controls collection.
         CheckBox taxCheck = (CheckBox)e.Item.Cells[2].Controls[1];

         String item = e.Item.Cells[1].Text;
         String price = priceText.Text;
       
         DataRow dr;

         // With a database, use an update command.  Since the data source is 
         // an in-memory DataTable, delete the old row and replace it with a new one.

         // Remove old entry.
         StoreView.RowFilter = "Item='" + item + "'";
         if (StoreView.Count > 0)
            StoreView.Delete(0);
         StoreView.RowFilter = "";
 
         // Add new entry.
         dr = Store.NewRow();

         if (taxCheck.Checked)
            dr[0] = "8.6%";
         else 
            dr[0] = "0.0%";
         dr[1] = item;
         dr[2] = price;
         Store.Rows.Add(dr);

         MyDataGrid.EditItemIndex = -1;
         BindGrid();
      }

      void BindGrid() 
      {
         MyDataGrid.DataSource = StoreView;
         MyDataGrid.DataBind();
      }

   </script>

<head runat="server">
    <title>TemplateColumn Example</title>
</head>
<body>

   <form id="form1" runat="server">

      <h3>TemplateColumn Example</h3>

      <asp:DataGrid id="MyDataGrid" runat="server"
           BorderColor="black"
           CellPadding="2"        
           OnEditCommand="MyDataGrid_Edit"
           OnCancelCommand="MyDataGrid_Cancel"
           OnUpdateCommand="MyDataGrid_Update"
           ShowFooter="True"
           AutoGenerateColumns="false">

         <Columns>

            <asp:EditCommandColumn
                 EditText="Edit"
                 CancelText="Cancel"
                 UpdateText="Update"
                 ItemStyle-Wrap="false"
                 HeaderText="Edit Controls"/>

            <asp:BoundColumn HeaderText="Description" 
                 ReadOnly="true" 
                 DataField="Item"/>

            <asp:TemplateColumn>

               <HeaderTemplate>
                  <b> Tax </b>
               </HeaderTemplate>

               <ItemTemplate>
                  <asp:Label
                       Text='<%# DataBinder.Eval(Container.DataItem, "Tax") %>'
                       runat="server"/>
               </ItemTemplate>

               <EditItemTemplate>

                  <asp:CheckBox
                       Text="Taxable" 
                       runat="server"/>

               </EditItemTemplate>

               <FooterTemplate>
                  <asp:HyperLink id="HyperLink1"
                       Text="Microsoft"
                       NavigateUrl="http://www.microsoft.com"
                       runat="server"/>
               </FooterTemplate>

            </asp:TemplateColumn>

            <asp:BoundColumn HeaderText="Price" 
                 DataField="Price"/>

         </Columns>

      </asp:DataGrid>

   </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">

      Private Store As DataTable = New DataTable()
      Private StoreView As DataView  

      Sub Page_Load(sender As Object, e As EventArgs) 
     
         If IsNothing(Session("StoreData")) Then 
         
            Dim dr As DataRow
            Dim i As Integer
 
            Store = New DataTable()      

            Store.Columns.Add(New DataColumn("Tax", GetType(String)))
            Store.Columns.Add(New DataColumn("Item", GetType(String)))
            Store.Columns.Add(New DataColumn("Price", GetType(String)))

            Session("StoreData") = Store
            
            ' Create sample data.
            For i = 1 to 4 
    
               dr = Store.NewRow()

               dr(0) = "0.0%"
               dr(1) = "Item " & i.ToString()
               dr(2) = (1.23 * (i + 1)).ToString()
 
               Store.Rows.Add(dr)

            Next i       

         Else
            Store = Session("StoreData")

         End If

         StoreView = New DataView(Store)
         StoreView.Sort="Item"

         If Not IsPostBack Then                    
            BindGrid()
         End If
                   
      End Sub

      Sub MyDataGrid_Edit(sender As Object, e As DataGridCommandEventArgs) 
      
         MyDataGrid.EditItemIndex = e.Item.ItemIndex
         BindGrid()

      End Sub

      Sub MyDataGrid_Cancel(sender As Object, e As DataGridCommandEventArgs) 
      
         MyDataGrid.EditItemIndex = -1
         BindGrid()

      End Sub

      Sub MyDataGrid_Update(sender As Object, e As DataGridCommandEventArgs) 
      
         ' Get the text box that contains the price to edit. 
         ' For bound columns the edited value is stored in a text box.
         ' The text box is the first control in the Controls collection.
         Dim priceText As TextBox = e.Item.Cells(3).Controls(0)

         ' Get the check box that indicates whether to include tax from the 
         ' TemplateColumn. Notice that in this case, the check box control is
         ' second control in the Controls collection.
         Dim taxCheck As CheckBox = e.Item.Cells(2).Controls(1)

         Dim item As String = e.Item.Cells(1).Text
         Dim price As String = priceText.Text
       
         Dim dr As DataRow

         ' With a database, use an update command.  Since the data source is 
         ' an in-memory DataTable, delete the old row and replace it with a new one.

         ' Remove old entry.
         StoreView.RowFilter = "Item='" & item & "'"
         If StoreView.Count > 0 Then
            StoreView.Delete(0)
         End If
         StoreView.RowFilter = ""
 
         ' Add new entry.
         dr = Store.NewRow()

         If taxCheck.Checked Then
            dr(0) = "8.6%"
         Else 
            dr(0) = "0.0%"
         End If
         dr(1) = item
         dr(2) = price
         Store.Rows.Add(dr)

         MyDataGrid.EditItemIndex = -1
         BindGrid()

      End Sub

      Sub BindGrid() 
      
         MyDataGrid.DataSource = StoreView
         MyDataGrid.DataBind()
      
      End Sub

   </script>

<head runat="server">
    <title>TemplateColumn Example</title>
</head>
<body>

   <form id="form1" runat="server">

      <h3>TemplateColumn Example</h3>

      <asp:DataGrid id="MyDataGrid" runat="server"
           BorderColor="black"
           CellPadding="2"        
           OnEditCommand="MyDataGrid_Edit"
           OnCancelCommand="MyDataGrid_Cancel"
           OnUpdateCommand="MyDataGrid_Update"
           ShowFooter="True"
           AutoGenerateColumns="false">

         <Columns>

            <asp:EditCommandColumn
                 EditText="Edit"
                 CancelText="Cancel"
                 UpdateText="Update"
                 ItemStyle-Wrap="false"
                 HeaderText="Edit Controls"/>

            <asp:BoundColumn HeaderText="Description" 
                 ReadOnly="true" 
                 DataField="Item"/>

            <asp:TemplateColumn>

               <HeaderTemplate>
                  <b> Tax </b>
               </HeaderTemplate>

               <ItemTemplate>
                  <asp:Label
                       Text='<%# DataBinder.Eval(Container.DataItem, "Tax") %>'
                       runat="server"/>
               </ItemTemplate>

               <EditItemTemplate>

                  <asp:CheckBox
                       Text="Taxable" 
                       runat="server"/>

               </EditItemTemplate>

               <FooterTemplate>
                  <asp:HyperLink id="HyperLink1"
                       Text="Microsoft"
                       NavigateUrl="http://www.microsoft.com"
                       runat="server"/>
               </FooterTemplate>

            </asp:TemplateColumn>

            <asp:BoundColumn HeaderText="Price" 
                 DataField="Price"/>

         </Columns>

      </asp:DataGrid>

   </form>

</body>
</html>

注釈

コントロールのTemplateColumn列の型を使用して、カスタマイズされたコントロールレイアウトを持つ列を作成します。 DataGridUse the TemplateColumn column type in a DataGrid control to create a column with a customized control layout. HeaderTemplateFooterTemplate、およびItemTemplateの各プロパティを使用して、列の見出しセクション、フッターセクション、および項目セクションに対してカスタムの外観を提供できます。You can provide a custom appearance for the heading section, the footer section, and the items section of the column by using the HeaderTemplate, FooterTemplate, and ItemTemplate properties, respectively. また、プロパティをTemplateColumn EditItemTemplate設定することにより、編集する項目をオブジェクトに表示する方法を制御することもできます。You can also control how an item being edited is displayed in the TemplateColumn object by setting the EditItemTemplate property.

コンストラクター

TemplateColumn() TemplateColumn() TemplateColumn() TemplateColumn()

TemplateColumn クラスの新しいインスタンスを初期化します。Initializes a new instance of the TemplateColumn class.

プロパティ

DesignMode DesignMode DesignMode DesignMode

列がデザイン モードかどうかを示す値を取得します。Gets a value that indicates whether the column is in design mode.

(Inherited from DataGridColumn)
EditItemTemplate EditItemTemplate EditItemTemplate EditItemTemplate

TemplateColumn オブジェクトの編集対象として選択された項目を表示するときに使用するテンプレートを取得または設定します。Gets or sets the template for displaying the item selected for editing in a TemplateColumn object.

FooterStyle FooterStyle FooterStyle FooterStyle

列のフッター セクションのスタイル プロパティを取得します。Gets the style properties for the footer section of the column.

(Inherited from DataGridColumn)
FooterTemplate FooterTemplate FooterTemplate FooterTemplate

TemplateColumn オブジェクトのフッター セクションを表示するときに使用するテンプレートを取得または設定します。Gets or sets the template for displaying the footer section of the TemplateColumn object.

FooterText FooterText FooterText FooterText

列のフッター セクションに表示されるテキストを取得または設定します。Gets or sets the text displayed in the footer section of the column.

(Inherited from DataGridColumn)
HeaderImageUrl HeaderImageUrl HeaderImageUrl HeaderImageUrl

列のヘッダー セクションに表示するイメージの位置を取得または設定します。Gets or sets the location of an image to display in the header section of the column.

(Inherited from DataGridColumn)
HeaderStyle HeaderStyle HeaderStyle HeaderStyle

列のヘッダー セクションのスタイル プロパティを取得します。Gets the style properties for the header section of the column.

(Inherited from DataGridColumn)
HeaderTemplate HeaderTemplate HeaderTemplate HeaderTemplate

TemplateColumn オブジェクトの見出しセクションを表示するときに使用するテンプレートを取得または設定します。Gets or sets the template for displaying the heading section of the TemplateColumn object.

HeaderText HeaderText HeaderText HeaderText

列のヘッダー セクションに表示されるテキストを取得または設定します。Gets or sets the text displayed in the header section of the column.

(Inherited from DataGridColumn)
IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState

列がビューステートの変化を追跡しているかどうかを示す値を取得します。Gets a value that indicates whether the column is tracking view state changes.

(Inherited from DataGridColumn)
IsTrackingViewState IsTrackingViewState IsTrackingViewState IsTrackingViewState

DataGridColumn オブジェクトが状態を保存するようにマークされているかどうかを判断する値を取得します。Gets a value that determines whether the DataGridColumn object is marked to save its state.

(Inherited from DataGridColumn)
ItemStyle ItemStyle ItemStyle ItemStyle

列の項目セルのスタイル プロパティを取得します。Gets the style properties for the item cells of the column.

(Inherited from DataGridColumn)
ItemTemplate ItemTemplate ItemTemplate ItemTemplate

TemplateColumn オブジェクトのデータ項目を表示するときに使用するテンプレートを取得または設定します。Gets or sets the template for displaying a data item in a TemplateColumn object.

Owner Owner Owner Owner

列がメンバーとして含まれている DataGrid コントロールを取得します。Gets the DataGrid control that the column is a member of.

(Inherited from DataGridColumn)
SortExpression SortExpression SortExpression SortExpression

並べ替えのために列が選択された場合に、OnSortCommand(DataGridSortCommandEventArgs) メソッドに渡されるフィールドの名前または式を、取得または設定します。Gets or sets the name of the field or expression to pass to the OnSortCommand(DataGridSortCommandEventArgs) method when a column is selected for sorting.

(Inherited from DataGridColumn)
ViewState ViewState ViewState ViewState

StateBag クラスから派生した列がそのプロパティを格納できるようにする DataGridColumn オブジェクトを取得します。Gets the StateBag object that allows a column derived from the DataGridColumn class to store its properties.

(Inherited from DataGridColumn)
Visible Visible Visible Visible

DataGrid コントロールに列を表示するかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the column is visible in the DataGrid control.

(Inherited from DataGridColumn)

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
Initialize() Initialize() Initialize() Initialize()

DataGridColumn クラスから派生した列を初期状態にリセットする基本実装を提供します。Provides the base implementation to reset a column derived from the DataGridColumn class to its initial state.

(Inherited from DataGridColumn)
InitializeCell(TableCell, Int32, ListItemType) InitializeCell(TableCell, Int32, ListItemType) InitializeCell(TableCell, Int32, ListItemType) InitializeCell(TableCell, Int32, ListItemType)

TableCell オブジェクトの基本クラスを呼び出してインスタンスを初期化した後、ListItemType をセルに適用します。Calls a TableCell object's base class to initialize the instance and then applies a ListItemType to the cell.

LoadViewState(Object) LoadViewState(Object) LoadViewState(Object) LoadViewState(Object)

DataGridColumn オブジェクトの状態を読み込みます。Loads the state of the DataGridColumn object.

(Inherited from DataGridColumn)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
OnColumnChanged() OnColumnChanged() OnColumnChanged() OnColumnChanged()

OnColumnsChanged() メソッドを呼び出します。Calls the OnColumnsChanged() method.

(Inherited from DataGridColumn)
SaveViewState() SaveViewState() SaveViewState() SaveViewState()

DataGridColumn オブジェクトの現在の状態を保存します。Saves the current state of the DataGridColumn object.

(Inherited from DataGridColumn)
ToString() ToString() ToString() ToString()

列の文字列形式を返します。Returns the string representation of the column.

(Inherited from DataGridColumn)
TrackViewState() TrackViewState() TrackViewState() TrackViewState()

サーバー コントロールにビューステートの変更を追跡させ、サーバー コントロールの StateBag オブジェクトに変更を格納できるようにします。Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object.

(Inherited from DataGridColumn)

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

IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object)

以前に保存した状態を読み込みます。Loads previously saved state.

(Inherited from DataGridColumn)
IStateManager.SaveViewState() IStateManager.SaveViewState() IStateManager.SaveViewState() IStateManager.SaveViewState()

状態の変化を示すオブジェクトを返します。Returns an object containing state changes.

(Inherited from DataGridColumn)
IStateManager.TrackViewState() IStateManager.TrackViewState() IStateManager.TrackViewState() IStateManager.TrackViewState()

状態変化の追跡を開始します。Starts tracking state changes.

(Inherited from DataGridColumn)

適用対象

こちらもご覧ください