TemplateField Класс

Определение

Представляет поле, отображающее настраиваемое содержимое в элементе управления с привязкой к данным.Represents a field that displays custom content in a data-bound control.

public ref class TemplateField : System::Web::UI::WebControls::DataControlField
public class TemplateField : System.Web.UI.WebControls.DataControlField
type TemplateField = class
    inherit DataControlField
Public Class TemplateField
Inherits DataControlField
Наследование
TemplateField

Примеры

В следующем примере кода показано, как создать пользовательский TemplateField объект, отображающий два поля в одной ячейке.The following code example demonstrates how to create a custom TemplateField object that displays two fields in the same cell. Поля First Name и Last Name объединяются в один и тот же TemplateField объект.The first name and last name fields are combined into the same TemplateField object.


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

<!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" >
  <head runat="server">
    <title>TemplateField Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>TemplateField Example</h3>

      <!-- Populate the Columns collection declaratively. -->
      <!-- Create a custom TemplateField column that uses      -->
      <!-- two Label controls to display an author's first and -->
      <!-- last name in the same column.                       -->
      <asp:gridview id="AuthorsGridView" 
        datasourceid="AuthorsSqlDataSource" 
        autogeneratecolumns="False"
        runat="server">
                
        <columns>
                
          <asp:templatefield headertext="Author Name">
            <itemtemplate>
              <asp:label id="FirstNameLabel"
                Text= '<%# Eval("au_fname") %>'
                runat="server"/> 
              <asp:label id="LastNameLabel"
                Text= '<%# Eval("au_lname") %>'
                runat="server"/>
            </itemtemplate>
          </asp:templatefield>
                
        </columns>
                
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects -->
      <!-- to the Pubs sample database.                        -->
      <asp:sqldatasource id="AuthorsSqlDataSource"  
        selectcommand="SELECT [au_lname], [au_fname], [address], [city], [state], [zip], [contract] FROM [authors]"
        connectionstring="server=localhost;database=pubs;integrated security=SSPI"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>


<%@ Page language="VB" %>

<!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" >
  <head runat="server">
    <title>TemplateField Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>TemplateField Example</h3>

      <!-- Populate the Columns collection declaratively. -->
      <!-- Create a custom TemplateField column that uses      -->
      <!-- two Label controls to display an author's first and -->
      <!-- last name in the same column.                       -->
      <asp:gridview id="AuthorsGridView" 
        datasourceid="AuthorsSqlDataSource" 
        autogeneratecolumns="False"
        runat="server">
                
        <columns>
                
          <asp:templatefield headertext="Author Name">
            <itemtemplate>
              <asp:label id="FirstNameLabel"
                text= '<%# Eval("au_fname") %>'
                runat="server"/> 
              <asp:label id="LastNameLabel"
                text= '<%# Eval("au_lname") %>'
                runat="server"/>
            </itemtemplate>
          </asp:templatefield>
                
        </columns>
                
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects -->
      <!-- to the Pubs sample database.                        -->
      <asp:sqldatasource id="AuthorsSqlDataSource"  
        selectcommand="SELECT [au_lname], [au_fname], [address], [city], [state], [zip], [contract] FROM [authors]"
        connectionstring="server=localhost;database=pubs;integrated security=SSPI"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>

Комментарии

TemplateFieldКласс используется элементами управления с привязкой к данным (например GridView , и DetailsView ) для отображения пользовательского содержимого для каждой отображаемой записи.The TemplateField class is used by data-bound controls (such as GridView and DetailsView) to display custom content for each record displayed. Если необходимо отобразить содержимое в элементе управления с привязкой к данным, который не предоставляется одним из стандартных полей элемента управления данными (например BoundField ,), используйте TemplateField класс для создания пользовательского пользовательского интерфейса.When you need to display content in a data-bound control that is not provided by one of the predefined data control fields (such as BoundField), use the TemplateField class to create your custom user interface (UI). TemplateFieldОбъект отображается по-разному в зависимости от привязанного к данным элемента управления, в котором он используется.The TemplateField object is displayed differently depending on the data-bound control in which it is used. Например, GridView элемент управления отображает объект в TemplateField виде столбца, а DetailsView элемент управления отображает его как строку.For example, the GridView control displays a TemplateField object as a column, and the DetailsView control displays it as a row.

Можно определить пользовательский шаблон для различных частей TemplateField объекта, используя шаблоны, перечисленные в следующей таблице.You can define a custom template for the different parts of the TemplateField object using the templates listed in the following table.

ШаблонTemplate ОписаниеDescription
AlternatingItemTemplate Указывает содержимое, отображаемое для чередующихся элементов в TemplateField объекте.Specifies the content to display for the alternating items in a TemplateField object.
EditItemTemplate Задает содержимое, отображаемое для элемента в режиме редактирования в TemplateField объекте.Specifies the content to display for an item in edit mode in a TemplateField object.
FooterTemplate Задает содержимое, отображаемое для нижнего колонтитула TemplateField объекта.Specifies the content to display for the footer section of a TemplateField object.
HeaderTemplate Задает содержимое, отображаемое для раздела заголовка TemplateField объекта.Specifies the content to display for the header section of a TemplateField object.
InsertItemTemplate Задает содержимое, отображаемое для элемента в режиме вставки в TemplateField объекте.Specifies the content to display for an item in insert mode in a TemplateField object. Этот шаблон поддерживается только DetailsView элементом управления.This template is supported only by the DetailsView control.
ItemTemplate Указывает содержимое, отображаемое для элементов в TemplateField объекте.Specifies the content to display for the items in a TemplateField object.

Можно скрыть TemplateField объект в элементе управления с привязкой к данным, задав Visible свойству значение false .You can hide a TemplateField object in a data-bound control by setting the Visible property to false.

В качестве альтернативы для определения пользовательского HeaderTemplate FooterTemplate шаблона или можно настроить разделы верхнего и нижнего колонтитула TemplateField объекта, задав другие свойства TemplateField объекта.As an alternative to defining a custom HeaderTemplate or FooterTemplate template, you can customize the header and footer sections of a TemplateField object by setting other properties of the TemplateField object. Чтобы отобразить заголовок в разделах верхнего или нижнего колонтитула, задайте HeaderText FooterText свойство или соответственно.To display a caption in the header or footer sections, set the HeaderText or the FooterText property, respectively. Вместо отображения текста в разделе заголовка можно отобразить изображение, задав HeaderImageUrl свойство.Instead of displaying text in the header section, you can display an image by setting the HeaderImageUrl property. Раздел заголовка можно скрыть в TemplateField объекте, задав ShowHeader свойству значение false .The header section can be hidden in the TemplateField object by setting the ShowHeader property to false.

Примечание

Некоторые элементы управления с привязкой к данным (например, GridView элемент управления) могут отображать или скрывать только весь раздел заголовка элемента управления.Some data-bound controls (such as the GridView control) can show or hide only the entire header section of the control. Эти элементы управления с привязкой к данным не поддерживают ShowHeader свойство для отдельного привязанного поля.These data-bound controls do not support the ShowHeader property for an individual bound field. Чтобы показать или скрыть весь раздел заголовка элемента управления с привязкой к данным, используйте свойство элемента управления ShowHeader (если доступно).To show or hide the entire header section of a data-bound control, use the control's ShowHeader property (if available).

Можно также настроить внешний вид TemplateField объекта (цвет шрифта, цвет фона и т. д.), задав свойства стиля для различных частей поля.You also can customize the appearance of the TemplateField object (font color, background color, and so on) by setting the style properties for the different parts of the field. В следующей таблице перечислены различные свойства стиля.The following table lists the different style properties.

Свойство StyleStyle property ОписаниеDescription
ControlStyle Параметры стиля для дочерних серверных веб-элементов управления TemplateField объекта.The style settings for the child Web server controls of the TemplateField object.
FooterStyle Параметры стиля для нижнего колонтитула TemplateField объекта.The style settings for the footer section of the TemplateField object.
HeaderStyle Параметры стиля для раздела заголовка TemplateField объекта.The style settings for the header section of the TemplateField object.
ItemStyle Параметры стиля для элементов данных в TemplateField объекте.The style settings for the data items in the TemplateField object.

Конструкторы

TemplateField()

Инициализирует новый экземпляр класса TemplateField.Initializes a new instance of the TemplateField class.

Свойства

AccessibleHeaderText

Возвращает или задает текст, отображающийся как значение свойство AbbreviatedText некоторых элементов управления.Gets or sets text that is rendered as the AbbreviatedText property value in some controls.

(Унаследовано от DataControlField)
AlternatingItemTemplate

Получает или задает шаблон для отображения в объекте TemplateField элемента, претерпевающего изменения.Gets or sets the template for displaying the alternating items in a TemplateField object.

Control

Возвращает ссылку на элемент управления данными, с которым связан объект DataControlField.Gets a reference to the data control that the DataControlField object is associated with.

(Унаследовано от DataControlField)
ControlStyle

Получает стиль любых серверных веб-элементов управления, содержащихся в объекте DataControlField.Gets the style of any Web server controls contained by the DataControlField object.

(Унаследовано от DataControlField)
ConvertEmptyStringToNull

Возвращает или задает значение, указывающее на необходимость преобразования значения, к которому привязан объект TemplateField в null, если его значение равно Empty.Gets or sets a value indicating whether the value that the TemplateField object is bound to should be converted to null if it is Empty.

DesignMode

Возвращает значение, указывающее, просматривается ли в данный момент поле элемента управления данными в среде режима разработки.Gets a value indicating whether a data control field is currently viewed in a design-time environment.

(Унаследовано от DataControlField)
EditItemTemplate

Получает или задает шаблон для отображения элемента в режиме правки в объекте TemplateField.Gets or sets the template for displaying an item in edit mode in a TemplateField object.

FooterStyle

Возвращает или задает стиль нижнего колонтитула поля элемента управления данными.Gets or sets the style of the footer of the data control field.

(Унаследовано от DataControlField)
FooterTemplate

Получает или задает шаблон для отображения нижнего колонтитула объекта TemplateField.Gets or sets the template for displaying the footer section of a TemplateField object.

FooterText

Возвращает или задает текст для отображения в нижнем колонтитуле поля элемента управления данными.Gets or sets the text that is displayed in the footer item of a data control field.

(Унаследовано от DataControlField)
HeaderImageUrl

Возвращает или задает URL -адрес изображения для отображения в верхнем колонтитуле поля элемента управления данными.Gets or sets the URL of an image that is displayed in the header item of a data control field.

(Унаследовано от DataControlField)
HeaderStyle

Возвращает или задает стиль верхнего колонтитула поля элемента управления данными.Gets or sets the style of the header of the data control field.

(Унаследовано от DataControlField)
HeaderTemplate

Получает или задает шаблон для отображения верхнего колонтитула объекта TemplateField.Gets or sets the template for displaying the header section of a TemplateField object.

HeaderText

Возвращает или задает текст для отображения в верхнем колонтитуле поля элемента управления данными.Gets or sets the text that is displayed in the header item of a data control field.

(Унаследовано от DataControlField)
InsertItemTemplate

Получает или задает шаблон для отображения элемента в режиме вставки в объекте TemplateField.Gets or sets the template for displaying an item in insert mode in a TemplateField object.

InsertVisible

Возвращает значение, указывающее состояние отображения объекта DataControlField во время пребывания его родительского элемента управления, привязанного к данным, в режиме вставки.Gets a value indicating whether the DataControlField object is visible when its parent data-bound control is in insert mode.

(Унаследовано от DataControlField)
IsTrackingViewState

Получает значение, указывающее сохраняет ли объект DataControlField изменения в данных о состоянии представления.Gets a value indicating whether the DataControlField object is saving changes to its view state.

(Унаследовано от DataControlField)
ItemStyle

Возвращает стиль любого текстового содержимого, отображаемого полем элемента управления содержанием.Gets the style of any text-based content displayed by a data control field.

(Унаследовано от DataControlField)
ItemTemplate

Получает или задает шаблон для отображения элемента в элементе управления, привязанному к данным.Gets or sets the template for displaying an item in a data-bound control.

ShowHeader

Возвращает или задает значение, указывающее на необходимость отображения верхнего колонтитула для поля элемента управления данными.Gets or sets a value indicating whether the header item of a data control field is rendered.

(Унаследовано от DataControlField)
SortExpression

Возвращает или задает выражение сортировки, используемое элементом управления источником данных для сортировки данных.Gets or sets a sort expression that is used by a data source control to sort data.

(Унаследовано от DataControlField)
ValidateRequestMode

Получает или задает значение, указывающее, проверяет ли элемент управления клиентский ввод.Gets or sets a value that specifies whether the control validates client input.

ValidateRequestMode

Получает или задает значение, указывающее, проверяет ли элемент управления клиентский ввод.Gets or sets a value that specifies whether the control validates client input.

(Унаследовано от DataControlField)
ViewState

Возвращает словарь сведений о состоянии, позволяющих сохранять и восстанавливать состояние представления объекта DataControlField при нескольких запросах одной и той же страницы.Gets a dictionary of state information that allows you to save and restore the view state of a DataControlField object across multiple requests for the same page.

(Унаследовано от DataControlField)
Visible

Возвращает или задает значение, определяющее, отображается ли поле элемента управления данными.Gets or sets a value indicating whether a data control field is rendered.

(Унаследовано от DataControlField)

Методы

CloneField()

Создает точную копию текущего объекта, производного от DataControlField.Creates a duplicate copy of the current DataControlField-derived object.

(Унаследовано от DataControlField)
CopyProperties(DataControlField)

Копирует свойства текущего объекта, производного от TemplateField в указанный объект DataControlField.Copies the properties of the current TemplateField-derived object to the specified DataControlField object.

CreateField()

Создает новый объект TemplateField.Creates a new TemplateField object.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
ExtractValuesFromCell(IOrderedDictionary, DataControlFieldCell, DataControlRowState, Boolean)

Получает значение полей элемента управления данными, как указано односторонним или обоюдным оператором привязки (DataBind)из текущей ячейки таблицы и добавляет значения в указанную коллекцию IOrderedDictionary.Extracts the value of the data control fields as specified by one or more two-way binding statements (DataBind) from the current table cell and adds the values to the specified IOrderedDictionary collection.

GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
Initialize(Boolean, Control)

Производит базовую инициализацию экземпляра для поля элемента управления данными.Performs basic instance initialization for a data control field.

(Унаследовано от DataControlField)
InitializeCell(DataControlFieldCell, DataControlCellType, DataControlRowState, Int32)

Добавляет в коллекцию ячейки элемента управления текст или элементы управления.Adds text or controls to a cell's controls collection.

LoadViewState(Object)

Восстанавливает сохраненное раннее состояние представления источника данных.Restores the data source view's previously saved view state.

(Унаследовано от DataControlField)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
OnFieldChanged()

Вызывает событие FieldChanged.Raises the FieldChanged event.

(Унаследовано от DataControlField)
SaveViewState()

Сохраняет изменения в состояние объекта DataControlField после того, как страница отправлена на сервер.Saves the changes made to the DataControlField view state since the time the page was posted back to the server.

(Унаследовано от DataControlField)
ToString()

Возврат строки, представляющей объект DataControlField.Returns a string that represents this DataControlField object.

(Унаследовано от DataControlField)
TrackViewState()

Инициирует отслеживание объектом DataControlField изменений в состоянии его представления, благодаря чему эти изменения можно сохранить в свойстве элемента ViewState элемента управления и хранить их для всех запросов одной и той же страницы.Causes the DataControlField object to track changes to its view state so they can be stored in the control's ViewState property and persisted across requests for the same page.

(Унаследовано от DataControlField)
ValidateSupportsCallback()

Определяет поддержку ответов страницы элементами управления, содержащимися в объекте TemplateField.Determines whether the controls contained in a TemplateField object support page callbacks.

Явные реализации интерфейса

IDataSourceViewSchemaAccessor.DataSourceViewSchema

Возвращает или задает схему, связанную с этим объектом DataControlField.Gets or sets the schema associated with this DataControlField object.

(Унаследовано от DataControlField)
IStateManager.IsTrackingViewState

Получает значение, указывающее сохраняет ли объект DataControlField изменения в данных о состоянии представления.Gets a value indicating whether the DataControlField object is saving changes to its view state.

(Унаследовано от DataControlField)
IStateManager.LoadViewState(Object)

Восстанавливает сохраненное раннее состояние представления поля источника данных.Restores the data control field's previously saved view state.

(Унаследовано от DataControlField)
IStateManager.SaveViewState()

Сохраняет изменения в состояние объекта DataControlField после того, как страница отправлена на сервер.Saves the changes made to the DataControlField view state since the time the page was posted back to the server.

(Унаследовано от DataControlField)
IStateManager.TrackViewState()

Инициирует отслеживание объектом DataControlField изменений в состоянии его представления, благодаря чему эти изменения можно сохранить в свойстве элемента ViewState элемента управления и хранить их для всех запросов одной и той же страницы.Causes the DataControlField object to track changes to its view state so they can be stored in the control's ViewState property and persisted across requests for the same page.

(Унаследовано от DataControlField)

Применяется к

См. также раздел