ButtonFieldBase Class

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Serves as the abstract base class for button fields, such as the ButtonField or CommandField class. The ButtonFieldBase class provides the methods and properties that are common to all button fields.

public ref class ButtonFieldBase abstract : System::Web::UI::WebControls::DataControlField

public abstract class ButtonFieldBase : System.Web.UI.WebControls.DataControlField

type ButtonFieldBase = class
    inherit DataControlField

Public MustInherit Class ButtonFieldBase
Inherits DataControlField

Inheritance: Object

DataControlField
ButtonFieldBase

Derived: System.Web.UI.WebControls.ButtonField

System.Web.UI.WebControls.CommandField

Remarks

The ButtonFieldBase class is the abstract base class for button fields and contains the methods and properties that are common to all button fields. Because this class is abstract, you cannot create an instance of it directly. Instead, you must create an instance of a non-abstract class that inherits from the ButtonFieldBase class, such as the ButtonField or CommandField class.

An object that is derived from the ButtonFieldBase is used by data-bound controls (such as the GridView and DetailsView controls) to display one or more buttons for each record that is displayed. A button field is displayed differently depending on the data-bound control in which it is used. For example, the GridView control displays a button field as a column, whereas the DetailsView control displays it as a row.

Clicking a button in a button field raises the command event of the parent data-bound control. You can provide a custom routine to perform when a button is clicked by providing an event handler for the command event.

Note

The GridView control raises the RowCommand event, whereas the DetailsView control raises the ItemCommand event.

To specify the type of button to display, use the ButtonType property. To show or hide the header section of a ButtonFieldBase object, set the ShowHeader property.

Note

Some data-bound controls (such as the GridView control) can show or hide only the entire header section of the control. These data-bound controls do not support the ShowHeader property for an individual button field. To show or hide the entire header section of a data-bound control (if available), use the ShowHeader property for the control.

Notes to Implementers

When you inherit from the ButtonFieldBase class, you must override the following member: CopyProperties(DataControlField).

Constructors

ButtonFieldBase()

Initializes a new instance of the ButtonFieldBase class.

Properties

AccessibleHeaderText	Gets or sets text that is rendered as the `AbbreviatedText` property value in some controls. (Inherited from DataControlField)
ButtonType	Gets or sets the button type to display in the button field.
CausesValidation	Gets or sets a value indicating whether validation is performed when a button in a ButtonFieldBase object is clicked.
Control	Gets a reference to the data control that the DataControlField object is associated with. (Inherited from DataControlField)
ControlStyle	Gets the style of any Web server controls contained by the DataControlField object. (Inherited from DataControlField)
DesignMode	Gets a value indicating whether a data control field is currently viewed in a design-time environment. (Inherited from DataControlField)
FooterStyle	Gets or sets the style of the footer of the data control field. (Inherited from DataControlField)
FooterText	Gets or sets the text that is displayed in the footer item of a data control field. (Inherited from DataControlField)
HeaderImageUrl	Gets or sets the URL of an image that is displayed in the header item of a data control field. (Inherited from DataControlField)
HeaderStyle	Gets or sets the style of the header of the data control field. (Inherited from DataControlField)
HeaderText	Gets or sets the text that is displayed in the header item of a data control field. (Inherited from DataControlField)
InsertVisible	Gets a value indicating whether the DataControlField object is visible when its parent data-bound control is in insert mode. (Inherited from DataControlField)
IsTrackingViewState	Gets a value indicating whether the DataControlField object is saving changes to its view state. (Inherited from DataControlField)
ItemStyle	Gets the style of any text-based content displayed by a data control field. (Inherited from DataControlField)
ShowHeader	Gets or sets a value indicating whether the header section is displayed in a ButtonFieldBase object.
SortExpression	Gets or sets a sort expression that is used by a data source control to sort data. (Inherited from DataControlField)
ValidateRequestMode	Gets or sets a value that specifies whether the control validates client input. (Inherited from DataControlField)
ValidationGroup	Gets or sets the name of the group of validation controls to validate when a button in a ButtonFieldBase object is clicked.
ViewState	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. (Inherited from DataControlField)
Visible	Gets or sets a value indicating whether a data control field is rendered. (Inherited from DataControlField)

Methods

CloneField()	Creates a duplicate copy of the current DataControlField-derived object. (Inherited from DataControlField)
CopyProperties(DataControlField)	Copies the properties of the current object that is derived from the ButtonFieldBase class to the specified DataControlField object.
CreateField()	When overridden in a derived class, creates an empty DataControlField-derived object. (Inherited from DataControlField)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
ExtractValuesFromCell(IOrderedDictionary, DataControlFieldCell, DataControlRowState, Boolean)	Extracts the value of the data control field from the current table cell and adds the value to the specified IDictionary collection. (Inherited from DataControlField)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
Initialize(Boolean, Control)	Performs basic instance initialization for a data control field. (Inherited from DataControlField)
InitializeCell(DataControlFieldCell, DataControlCellType, DataControlRowState, Int32)	Adds text or controls to a cell's controls collection. (Inherited from DataControlField)
LoadViewState(Object)	Restores the data source view's previously saved view state. (Inherited from DataControlField)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnFieldChanged()	Raises the `FieldChanged` event. (Inherited from DataControlField)
SaveViewState()	Saves the changes made to the DataControlField view state since the time the page was posted back to the server. (Inherited from DataControlField)
ToString()	Returns a string that represents this DataControlField object. (Inherited from DataControlField)
TrackViewState()	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. (Inherited from DataControlField)
ValidateSupportsCallback()	When overridden in a derived class, signals that the controls contained by a field support callbacks. (Inherited from DataControlField)

Explicit Interface Implementations

IDataSourceViewSchemaAccessor.DataSourceViewSchema	Gets or sets the schema associated with this DataControlField object. (Inherited from DataControlField)
IStateManager.IsTrackingViewState	Gets a value indicating whether the DataControlField object is saving changes to its view state. (Inherited from DataControlField)
IStateManager.LoadViewState(Object)	Restores the data control field's previously saved view state. (Inherited from DataControlField)
IStateManager.SaveViewState()	Saves the changes made to the DataControlField view state since the time the page was posted back to the server. (Inherited from DataControlField)
IStateManager.TrackViewState()	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. (Inherited from DataControlField)

Applies to

Jaa