ButtonColumn Class

.NET Framework (current version)

Other Versions

A column type for the DataGrid control that contains a user-defined button.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)

Inheritance Hierarchy

System::Object
System.Web.UI.WebControls::DataGridColumn
System.Web.UI.WebControls::ButtonColumn

Syntax

C++

public ref class ButtonColumn : DataGridColumn

Constructors

	Name	Description
	ButtonColumn()	Initializes a new instance of the ButtonColumn class.

Properties

	Name	Description
	ButtonType	Gets or sets the type of button to display in the ButtonColumn object.
	CausesValidation	Gets or sets a value indicating whether validation is performed when a button in the ButtonColumn object is clicked.
	CommandName	Gets or sets a string that represents the command to perform when a button in the System.Web.UI.WebControls::ButtonColumn object is clicked.
	DataTextField	Gets or sets the field name from a data source to bind to the ButtonColumn object.
	DataTextFormatString	Gets or sets the string that specifies the display format for the caption in each button.
	DesignMode	Gets a value that indicates whether the column is in design mode.(Inherited from DataGridColumn.)
	FooterStyle	Gets the style properties for the footer section of the column.(Inherited from DataGridColumn.)
	FooterText	Gets or sets the text displayed in the footer section of the column.(Inherited from DataGridColumn.)
	HeaderImageUrl	Gets or sets the location of an image to display in the header section of the column.(Inherited from DataGridColumn.)
	HeaderStyle	Gets the style properties for the header section of the column.(Inherited from DataGridColumn.)
	HeaderText	Gets or sets the text displayed in the header section of the column.(Inherited from DataGridColumn.)
	IsTrackingViewState	Gets a value that determines whether the DataGridColumn object is marked to save its state.(Inherited from DataGridColumn.)
	ItemStyle	Gets the style properties for the item cells of the column.(Inherited from DataGridColumn.)
	Owner	Gets the DataGrid control that the column is a member of.(Inherited from DataGridColumn.)
	SortExpression	Gets or sets the name of the field or expression to pass to the OnSortCommand method when a column is selected for sorting.(Inherited from DataGridColumn.)
	Text	Gets or sets the caption that is displayed in the buttons of the ButtonColumn object.
	ValidationGroup	Gets or sets the group of validation controls for which the ButtonColumn object causes validation when it posts back to the server.
	ViewState	Gets the System.Web.UI::StateBag object that allows a column derived from the DataGridColumn class to store its properties.(Inherited from DataGridColumn.)
	Visible	Gets or sets a value that indicates whether the column is visible in the DataGrid control.(Inherited from DataGridColumn.)

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	FormatDataTextValue(Object^)	Converts the specified value to the format that is indicated by the DataTextFormatString property.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	Initialize()	Resets the ButtonColumn object to its initial state.(Overrides DataGridColumn::Initialize().)
	InitializeCell(TableCell^, Int32, ListItemType)	Resets a cell in the ButtonColumn object to its initial state.(Overrides DataGridColumn::InitializeCell(TableCell^, Int32, ListItemType).)
	LoadViewState(Object^)	Loads the state of the DataGridColumn object.(Inherited from DataGridColumn.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	OnColumnChanged()	Calls the DataGridDesigner::OnColumnsChanged method.(Inherited from DataGridColumn.)
	SaveViewState()	Saves the current state of the DataGridColumn object.(Inherited from DataGridColumn.)
	ToString()	Returns the string representation of the column.(Inherited from DataGridColumn.)
	TrackViewState()	Causes tracking of view-state changes to the server control so they can be stored in the server control's System.Web.UI::StateBag object.(Inherited from DataGridColumn.)

Explicit Interface Implementations

	Name	Description
	IStateManager::LoadViewState(Object^)	This API supports the product infrastructure and is not intended to be used directly from your code. Loads previously saved state.(Inherited from DataGridColumn.)
	IStateManager::SaveViewState()	This API supports the product infrastructure and is not intended to be used directly from your code. Returns an object containing state changes.(Inherited from DataGridColumn.)
	IStateManager::TrackViewState()	This API supports the product infrastructure and is not intended to be used directly from your code. Starts tracking state changes.(Inherited from DataGridColumn.)
	IStateManager::IsTrackingViewState	This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value that indicates whether the column is tracking view state changes.(Inherited from DataGridColumn.)

Use the ButtonColumn class in a DataGrid control to create a button that corresponds with each row in the DataGrid control. Specify the caption that is displayed in the buttons by setting the Text property. If you set the Text property, all buttons in the ButtonColumn object share the same caption. Alternatively, you can bind the ButtonColumn buttons to a field in a data source. This allows you to display different captions for each button. The values in the specified field are used for the text caption. Set the DataTextField property to bind the ButtonColumn to a field in a data source.

You can format the captions that are displayed in the buttons by setting the DataTextField property with a formatting string.

Clicking the buttons in the ButtonColumn raises the ItemCommand event. You can programmatically control the action that is performed when the button is clicked by providing an event handler for the ItemCommand event.

By default, page validation is not performed when a button in the ButtonColumn is clicked. Page validation determines whether the input controls that are associated with a validation control on the page all pass the validation rules that are specified by the validation control. To perform page validation when a button is clicked, set the CausesValidation property to true.