TemplateColumn Classe

Referência

Definição

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Representa um tipo de coluna para o controle DataGrid que permite que você personalize o layout dos controles na coluna.

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

Herança: Object

DataGridColumn
TemplateColumn

Exemplos

O exemplo de código a seguir demonstra como usar a TemplateColumn classe para criar uma coluna no DataGrid controle com um layout personalizado.


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

Comentários

Use o TemplateColumn tipo de coluna em um DataGrid controle para criar uma coluna com um layout de controle personalizado. Você pode fornecer uma aparência personalizada para a seção título, a seção de rodapé e a seção de itens da coluna usando as HeaderTemplate FooterTemplatepropriedades, respectivamenteItemTemplate. Você também pode controlar como um item que está sendo editado é exibido no TemplateColumn objeto definindo a EditItemTemplate propriedade.

Construtores

TemplateColumn()

Inicializa uma nova instância da classe TemplateColumn.

Propriedades

DesignMode	Obtém um valor que indica se a coluna está no modo de design. (Herdado de DataGridColumn)
EditItemTemplate	Obtém ou define o modelo para exibir o item selecionado para edição em um objeto TemplateColumn.
FooterStyle	Obtém as propriedades de estilo da seção de rodapé da coluna. (Herdado de DataGridColumn)
FooterTemplate	Obtém ou define o modelo para exibir a seção de rodapé do objeto TemplateColumn.
FooterText	Obtém ou define o texto exibido na seção de rodapé da coluna. (Herdado de DataGridColumn)
HeaderImageUrl	Obtém ou define o local de uma imagem a ser exibida na seção de cabeçalho da coluna. (Herdado de DataGridColumn)
HeaderStyle	Obtém as propriedades de estilo para a seção de cabeçalho da coluna. (Herdado de DataGridColumn)
HeaderTemplate	Obtém ou define o modelo para exibir a seção de cabeçalho do objeto TemplateColumn.
HeaderText	Obtém ou define o texto exibido na seção de cabeçalho da coluna. (Herdado de DataGridColumn)
IsTrackingViewState	Obtém um valor que determina se o objeto DataGridColumn está marcado para salvar seu estado. (Herdado de DataGridColumn)
ItemStyle	Obtém as propriedades de estilo para as células do item da coluna. (Herdado de DataGridColumn)
ItemTemplate	Obtém ou define o modelo para a exibição de um item de dados em um objeto TemplateColumn.
Owner	Obtém o controle DataGrid do qual a coluna é membro. (Herdado de DataGridColumn)
SortExpression	Obtém ou define o nome do campo ou expressão a ser passado para o método OnSortCommand(DataGridSortCommandEventArgs) quando uma coluna for selecionada para classificação. (Herdado de DataGridColumn)
ViewState	Obtém o objeto StateBag que permite que uma coluna derivada da classe DataGridColumn armazene suas propriedades. (Herdado de DataGridColumn)
Visible	Obtém ou define um valor que indica se a coluna está visível no controle DataGrid. (Herdado de DataGridColumn)

Métodos

Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
Initialize()	Fornece a implementação base para redefinir uma coluna derivada da classe DataGridColumn para seu estado inicial. (Herdado de DataGridColumn)
InitializeCell(TableCell, Int32, ListItemType)	Chama a classe base de um objeto TableCell para inicializar a instância e, em seguida, aplica um ListItemType à célula.
LoadViewState(Object)	Carrega o estado do objeto DataGridColumn. (Herdado de DataGridColumn)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
OnColumnChanged()	Chama o método OnColumnsChanged(). (Herdado de DataGridColumn)
SaveViewState()	Salva o estado atual do objeto DataGridColumn. (Herdado de DataGridColumn)
ToString()	Retorna a representação de cadeia de caracteres da coluna. (Herdado de DataGridColumn)
TrackViewState()	Causa o acompanhamento das alterações de estado de exibição para o controle de servidor, para que elas possam ser armazenadas no objeto StateBag do controle de servidor. (Herdado de DataGridColumn)

Implantações explícitas de interface

IStateManager.IsTrackingViewState	Obtém um valor que indica se a coluna está controlando suas alterações de estado de exibição. (Herdado de DataGridColumn)
IStateManager.LoadViewState(Object)	Carrega o estado salvo anteriormente. (Herdado de DataGridColumn)
IStateManager.SaveViewState()	Retorna um objeto que contém as alterações de estado. (Herdado de DataGridColumn)
IStateManager.TrackViewState()	Inicia o controle de alterações de estado. (Herdado de DataGridColumn)

Aplica-se a