CommandField Класс

  • Ссылка

Определение

Пространство имен:
System.Web.UI.WebControls
Сборка:
System.Web.dll

Представляет специальное поле, которое отображает кнопки для выполнения операций выбора, редактирования, вставки или удаления в элементе управления с привязкой к данным.

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

Примеры

В следующем примере кода показано, как использовать CommandField поле для отображения элементов управления для изменения записи в элементе GridView управления.


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

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="false"
        datakeynames="CustomerID"  
        runat="server">
        
        <columns>
          <asp:commandfield showeditbutton="true"
            headertext="Edit Controls"/>
          <asp:boundfield datafield="CustomerID"
            headertext="Customer ID" />
          <asp:boundfield datafield="CompanyName"
            headertext="Company Name"/>
          <asp:boundfield datafield="Address"
            headertext="Address"/>
          <asp:boundfield datafield="City"
            headertext="City"/>
          <asp:boundfield datafield="PostalCode"
            headertext="ZIP Code"/>
          <asp:boundfield datafield="Country"
            headertext="Country"/>
        </columns>
        
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSqlDataSource"  
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        updatecommand="Update Customers Set CompanyName=@CompanyName, Address=@Address, City=@City, PostalCode=@PostalCode, Country=@Country Where (CustomerID = @CustomerID)"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        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>CommandField Example</title>
</head>
<body>
    <form id="form1" runat="server">
      
      <h3>CommandField Example</h3>

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="false"
        datakeynames="CustomerID"  
        runat="server">
        
        <columns>
          <asp:commandfield showeditbutton="true"
            headertext="Edit Controls"/>
          <asp:boundfield datafield="CustomerID"
            headertext="Customer ID" />
          <asp:boundfield datafield="CompanyName"
            headertext="Company Name"/>
          <asp:boundfield datafield="Address"
            headertext="Address"/>
          <asp:boundfield datafield="City"
            headertext="City"/>
          <asp:boundfield datafield="PostalCode"
            headertext="ZIP Code"/>
          <asp:boundfield datafield="Country"
            headertext="Country"/>
        </columns>
        
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSqlDataSource"  
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        updatecommand="Update Customers Set CompanyName=@CompanyName, Address=@Address, City=@City, PostalCode=@PostalCode, Country=@Country Where (CustomerID = @CustomerID)"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>

В следующем примере кода показано, как использовать CancelTextEditTextи UpdateText свойства для настройки текста для элементов управления редактированием.


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

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="false"
        datakeynames="CustomerID"  
        runat="server">
        
        <columns>
          <asp:commandfield showeditbutton="true"
            edittext="Edit Customer"
            canceltext="Discard"
            updatetext="Revise"
            headertext="Edit Controls"/>
          <asp:boundfield datafield="CustomerID"
            headertext="Customer ID" />
          <asp:boundfield datafield="CompanyName"
            headertext="Company Name"/>
          <asp:boundfield datafield="Address"
            headertext="Address"/>
          <asp:boundfield datafield="City"
            headertext="City"/>
          <asp:boundfield datafield="PostalCode"
            headertext="ZIP Code"/>
          <asp:boundfield datafield="Country"
            headertext="Country"/>
        </columns>
        
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSqlDataSource"  
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        updatecommand="Update Customers Set CompanyName=@CompanyName, Address=@Address, City=@City, PostalCode=@PostalCode, Country=@Country Where (CustomerID = @CustomerID)"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        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>CommandField Example</title>
</head>
<body>
    <form id="form1" runat="server">
      
      <h3>CommandField Example</h3>

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="false"
        datakeynames="CustomerID"  
        runat="server">
        
        <columns>
          <asp:commandfield showeditbutton="true"
            edittext="Edit Customer"
            canceltext="Discard"
            updatetext="Revise"
            headertext="Edit Controls"/>
          <asp:boundfield datafield="CustomerID"
            headertext="Customer ID" />
          <asp:boundfield datafield="CompanyName"
            headertext="Company Name"/>
          <asp:boundfield datafield="Address"
            headertext="Address"/>
          <asp:boundfield datafield="City"
            headertext="City"/>
          <asp:boundfield datafield="PostalCode"
            headertext="ZIP Code"/>
          <asp:boundfield datafield="Country"
            headertext="Country"/>
        </columns>
        
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSqlDataSource"  
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        updatecommand="Update Customers Set CompanyName=@CompanyName, Address=@Address, City=@City, PostalCode=@PostalCode, Country=@Country Where (CustomerID = @CustomerID)"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>

Комментарии

Класс CommandField — это специальное поле, используемое элементами управления с привязкой к данным (например GridView , и DetailsView) для отображения кнопок команд, которые выполняют операции удаления, редактирования, вставки или выбора. Кнопки команд для выполнения этих операций можно отображать или скрывать с помощью свойств, показанных в следующей таблице.

Свойство Описание:
ShowDeleteButton Отображает или скрывает кнопку "Удалить" в CommandField поле для каждой записи в элементе управления с привязкой к данным. Кнопка "Удалить" позволяет пользователю удалять запись из источника данных.
ShowEditButton Отображает или скрывает кнопку "Изменить" в поле для каждой записи в элементе управления с привязкой CommandField к данным. Кнопка "Изменить" позволяет пользователю изменять запись из источника данных. Когда пользователь нажимает кнопку "Изменить" для определенной записи, эта кнопка "Изменить" заменяется кнопкой "Обновить" и кнопкой "Отмена". Все остальные кнопки команд также скрыты.
ShowInsertButton Отображает или скрывает кнопку "Создать" в CommandField поле. Кнопка "Создать" позволяет пользователю вставлять новую запись в источник данных. Когда пользователь нажимает кнопку "Создать", он заменяется кнопкой "Вставить" и кнопкой "Отмена". Все остальные кнопки команд также скрыты. Примечание: Это свойство применяется только к элементам управления с привязкой к данным, поддерживающим операции вставки, такие как DetailsView элемент управления.
ShowSelectButton Отображает или скрывает кнопку "Выбрать" в поле для каждой записи в элементе управления с привязкой CommandField к данным. Кнопка "Выбрать" позволяет пользователю выбрать запись в элементе управления с привязкой к данным.

Кроме того, кнопка "Отмена", отображаемая, когда запись находится в режиме редактирования или вставки, можно отобразить или скрыть, задав ShowCancelButton свойство.

Примечание

Если элемент управления с привязкой к данным используется в сочетании с элементом управления источником данных (например SqlDataSource , элементом управления), элемент управления с привязкой к данным может воспользоваться возможностями элемента управления источником данных и обеспечить автоматическое удаление, обновление и вставку. Для других источников данных необходимо предоставить подпрограммы для выполнения этих операций во время соответствующих событий для элемента управления с привязкой к данным.

Поле CommandField отображается по-разному в зависимости от элемента управления с привязкой к данным, в котором он используется. Например, элемент GridView управления отображает CommandField поле в виде столбца, а DetailsView элемент управления отображает его как строку.

Чтобы указать тип отображаемой кнопки, используйте ButtonType свойство. ButtonType Если для свойства задано ButtonType.Button значение или ButtonType.Linkможно указать текст, отображаемый для кнопок, задав свойства, показанные в следующей таблице.

Свойство Описание:
CancelText Заголовок кнопки "Отмена".
DeleteText Заголовок кнопки "Удалить".
EditText Заголовок кнопки "Изменить".
InsertText Заголовок для кнопки "Вставить". Примечание: Это свойство применяется только к элементам управления с привязкой к данным, поддерживающим операции вставки, такие как DetailsView элемент управления.
NewText Заголовок кнопки "Создать". Примечание: Это свойство применяется только к элементам управления с привязкой к данным, поддерживающим операции вставки, такие как DetailsView элемент управления.
SelectText Заголовок для кнопки "Выбрать".
UpdateText Заголовок кнопки "Обновить".

Вместо того чтобы отображать кнопку команды или кнопку ссылки, можно отобразить кнопку изображения, задав ButtonType свойство ButtonType.Image и задав свойства, показанные в следующей таблице.

Свойство Описание:
CancelImageUrl Изображение, отображаемое для кнопки "Отмена"
DeleteImageUrl Изображение, отображаемое для кнопки "Удалить".
EditImageUrl Изображение, отображаемое для кнопки "Изменить".
InsertText Изображение, отображаемое для кнопки "Вставить". Примечание: Это свойство применяется только к элементам управления с привязкой к данным, поддерживающим операции вставки, такие как DetailsView элемент управления.
NewImageUrl Изображение, отображаемое для кнопки "Создать". Примечание: Это свойство применяется только к элементам управления с привязкой к данным, поддерживающим операции вставки, такие как DetailsView элемент управления.
SelectImageUrl Изображение, отображаемое для кнопки "Выбрать".
UpdateImageUrl Изображение, отображаемое для кнопки "Обновить".

По умолчанию, когда пользователь нажимает кнопку в CommandField поле, проверка выполняется во всех элементах управления проверки на странице. Чтобы предотвратить проверку при нажатии кнопки, задайте CausesValidation для свойства значение false.

Чтобы скрыть CommandField поле в элементе управления с привязкой к данным, присвойте свойству Visible значение false.

Поле CommandField позволяет настраивать его разделы верхнего и нижнего колонтитулов. Чтобы отобразить заголовок в разделе колонтитула, задайте HeaderText свойство или FooterText свойство соответственно. Вместо отображения текста в разделе заголовка можно отобразить изображение, задав HeaderImageUrl свойство. Чтобы скрыть раздел заголовка в объекте CommandField , задайте ShowHeader для свойства falseзначение .

Примечание

Некоторые элементы управления с привязкой к данным (например GridView , элемент управления) могут отображать или скрывать только весь раздел заголовка элемента управления. Эти элементы управления, привязанные к данным, не поддерживают ShowHeader свойство для отдельного поля кнопки. Чтобы отобразить или скрыть весь раздел заголовка элемента управления с привязкой к данным (если он доступен), используйте свойство элемента управления ShowHeader .

Вы также можете настроить внешний вид объекта (цвет шрифта CommandField , цвет фона и т. д.), задав свойства стиля для различных частей поля. В следующей таблице перечислены различные свойства стиля.

Свойство Style Описание
ControlStyle Параметры стиля для дочерних элементов управления CommandField веб-сервера объекта.
FooterStyle Параметры стиля для раздела нижнего CommandField колонтитула объекта.
HeaderStyle Параметры стиля для раздела заголовка CommandField объекта.
ItemStyle Параметры стиля для элементов данных в объекте CommandField .

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

CommandField()

Инициализирует новый экземпляр класса CommandField.

Свойства

AccessibleHeaderText

Возвращает или задает текст, отображающийся как значение свойство AbbreviatedText некоторых элементов управления.

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

Получает или задает тип кнопки, отображаемой в кнопочном поле.

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

Получает или задает URL-адрес изображения для кнопки "Отмена" в поле CommandField.
CancelText

Получает или задает заголовок для кнопки "Отмена", которая отображается в поле CommandField.
CausesValidation

Получает или задает значение, показывающее, выполняется ли проверка при нажатии кнопки в поле CommandField.
Control

Возвращает ссылку на элемент управления данными, с которым связан объект DataControlField.

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

Получает стиль любых серверных веб-элементов управления, содержащихся в объекте DataControlField.

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

Получает или задает URL-адрес изображения для кнопки "Удалить" в поле CommandField.
DeleteText

Получает или задает заголовок для кнопки "Удалить", которая отображается в поле CommandField.
DesignMode

Возвращает значение, указывающее, просматривается ли в данный момент поле элемента управления данными в среде режима разработки.

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

Получает или задает URL-адрес изображения для кнопки "Изменить" в поле CommandField.
EditText

Получает или задает заголовок для кнопки "Изменить", которая отображается в поле CommandField.
FooterStyle

Возвращает или задает стиль нижнего колонтитула поля элемента управления данными.

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

Возвращает или задает текст для отображения в нижнем колонтитуле поля элемента управления данными.

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

Возвращает или задает URL -адрес изображения для отображения в верхнем колонтитуле поля элемента управления данными.

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

Возвращает или задает стиль верхнего колонтитула поля элемента управления данными.

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

Возвращает или задает текст для отображения в верхнем колонтитуле поля элемента управления данными.

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

Получает или задает URL-адрес изображения для кнопки "Вставить" в поле CommandField.
InsertText

Получает или задает заголовок для кнопки "Вставить", которая отображается в поле CommandField.
InsertVisible

Возвращает значение, указывающее состояние отображения объекта DataControlField во время пребывания его родительского элемента управления, привязанного к данным, в режиме вставки.

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

Получает значение, указывающее сохраняет ли объект DataControlField изменения в данных о состоянии представления.

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

Возвращает стиль любого текстового содержимого, отображаемого полем элемента управления содержанием.

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

Получает или задает URL-адрес изображения для кнопки "Создать" в поле CommandField.
NewText

Получает или задает заголовок для кнопки "Создать", которая отображается в поле CommandField.
SelectImageUrl

Получает или задает URL-адрес изображения для кнопки "Выбрать" в поле CommandField.
SelectText

Получает или задает заголовок для кнопки "Выбрать", которая отображается в поле CommandField.
ShowCancelButton

Получает или задает значение, показывающее, отображается ли кнопка "Отмена" в поле CommandField.
ShowDeleteButton

Получает или задает значение, показывающее, отображается ли кнопка "Удалить" в поле CommandField.
ShowEditButton

Получает или задает значение, показывающее, отображается ли кнопка "Изменить" в поле CommandField.
ShowHeader

Получает или задает значение, позволяющее определить, отображается ли верхний колонтитул в элементе управления ButtonFieldBase.

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

Получает или задает значение, показывающее, отображается ли кнопка "Создать" в поле CommandField.
ShowSelectButton

Получает или задает значение, показывающее, отображается ли кнопка "Выбрать" в поле CommandField.
SortExpression

Возвращает или задает выражение сортировки, используемое элементом управления источником данных для сортировки данных.

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

Получает или задает URL-адрес изображения для кнопки "Обновить" в поле CommandField.
UpdateText

Получает или задает заголовок для кнопки "Обновить", которая отображается в поле CommandField.
ValidateRequestMode

Получает или задает значение, указывающее, проверяет ли элемент управления клиентский ввод.

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

Получает или задает имя группы проверочных элементов управления для проверки при нажатии кнопки в объекте ButtonFieldBase.

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

Возвращает словарь сведений о состоянии, позволяющих сохранять и восстанавливать состояние представления объекта DataControlField при нескольких запросах одной и той же страницы.

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

Возвращает или задает значение, определяющее, отображается ли поле элемента управления данными.

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

Методы

CloneField()

Создает точную копию текущего объекта, производного от DataControlField.

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

Копирует свойства текущего объекта CommandField в указанный объект DataControlField.
CreateField()

Создает пустой объект CommandField.
Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

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

Добывает значение поля элемента управления данными из текущей ячейки таблицы и добавляет значение в указанную коллекцию IDictionary.

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

Служит хэш-функцией по умолчанию.

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

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

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

Производит базовую инициализацию экземпляра для поля элемента управления данными.

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

Инициализирует указанный объект DataControlFieldCell заданным состоянием строки.
LoadViewState(Object)

Восстанавливает сохраненное раннее состояние представления источника данных.

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

Создает неполную копию текущего объекта Object.

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

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

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

Сохраняет изменения в состояние объекта DataControlField после того, как страница отправлена на сервер.

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

Возврат строки, представляющей объект DataControlField.

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

Инициирует отслеживание объектом DataControlField изменений в состоянии его представления, благодаря чему эти изменения можно сохранить в свойстве элемента ViewState элемента управления и хранить их для всех запросов одной и той же страницы.

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

Определяет поддержку обратных вызовов элементами управления, содержащимися в объекте CommandField.

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

IDataSourceViewSchemaAccessor.DataSourceViewSchema

Возвращает или задает схему, связанную с этим объектом DataControlField.

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

Получает значение, указывающее сохраняет ли объект DataControlField изменения в данных о состоянии представления.

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

Восстанавливает сохраненное раннее состояние представления поля источника данных.

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

Сохраняет изменения в состояние объекта DataControlField после того, как страница отправлена на сервер.

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

Инициирует отслеживание объектом DataControlField изменений в состоянии его представления, благодаря чему эти изменения можно сохранить в свойстве элемента ViewState элемента управления и хранить их для всех запросов одной и той же страницы.

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

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

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