ButtonColumn Class
TOC
Collapse the table of content
Expand the table of content

ButtonColumn Class

 

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)

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

public class ButtonColumn : DataGridColumn

NameDescription
System_CAPS_pubmethodButtonColumn()

Initializes a new instance of the ButtonColumn class.

NameDescription
System_CAPS_pubpropertyButtonType

Gets or sets the type of button to display in the ButtonColumn object.

System_CAPS_pubpropertyCausesValidation

Gets or sets a value indicating whether validation is performed when a button in the ButtonColumn object is clicked.

System_CAPS_pubpropertyCommandName

Gets or sets a string that represents the command to perform when a button in the System.Web.UI.WebControls.ButtonColumn object is clicked.

System_CAPS_pubpropertyDataTextField

Gets or sets the field name from a data source to bind to the ButtonColumn object.

System_CAPS_pubpropertyDataTextFormatString

Gets or sets the string that specifies the display format for the caption in each button.

System_CAPS_protpropertyDesignMode

Gets a value that indicates whether the column is in design mode.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyFooterStyle

Gets the style properties for the footer section of the column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyFooterText

Gets or sets the text displayed in the footer section of the column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyHeaderImageUrl

Gets or sets the location of an image to display in the header section of the column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyHeaderStyle

Gets the style properties for the header section of the column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyHeaderText

Gets or sets the text displayed in the header section of the column.(Inherited from DataGridColumn.)

System_CAPS_protpropertyIsTrackingViewState

Gets a value that determines whether the DataGridColumn object is marked to save its state.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyItemStyle

Gets the style properties for the item cells of the column.(Inherited from DataGridColumn.)

System_CAPS_protpropertyOwner

Gets the DataGrid control that the column is a member of.(Inherited from DataGridColumn.)

System_CAPS_pubpropertySortExpression

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.)

System_CAPS_pubpropertyText

Gets or sets the caption that is displayed in the buttons of the ButtonColumn object.

System_CAPS_pubpropertyValidationGroup

Gets or sets the group of validation controls for which the ButtonColumn object causes validation when it posts back to the server.

System_CAPS_protpropertyViewState

Gets the System.Web.UI.StateBag object that allows a column derived from the DataGridColumn class to store its properties.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyVisible

Gets or sets a value that indicates whether the column is visible in the DataGrid control.(Inherited from DataGridColumn.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_protmethodFormatDataTextValue(Object)

Converts the specified value to the format that is indicated by the DataTextFormatString property.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Resets the ButtonColumn object to its initial state.(Overrides DataGridColumn.Initialize().)

System_CAPS_pubmethodInitializeCell(TableCell, Int32, ListItemType)

Resets a cell in the ButtonColumn object to its initial state.(Overrides DataGridColumn.InitializeCell(TableCell, Int32, ListItemType).)

System_CAPS_protmethodLoadViewState(Object)

Loads the state of the DataGridColumn object.(Inherited from DataGridColumn.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnColumnChanged()

Calls the DataGridDesigner.OnColumnsChanged method.(Inherited from DataGridColumn.)

System_CAPS_protmethodSaveViewState()

Saves the current state of the DataGridColumn object.(Inherited from DataGridColumn.)

System_CAPS_pubmethodToString()

Returns the string representation of the column.(Inherited from DataGridColumn.)

System_CAPS_protmethodTrackViewState()

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.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.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.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIStateManager.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.

The following code example demonstrates how to use ButtonColumn class in a DataGrid control to create Add buttons.

private void Page_Init(Object sender, EventArgs e) 
{

   // Create dynamic column to add to Columns collection.
   ButtonColumn AddColumn = new ButtonColumn();
   AddColumn.HeaderText="Add Item"; 
   AddColumn.Text="Add";
   AddColumn.CommandName="Add";
   AddColumn.ButtonType = ButtonColumnType.PushButton;


   // Add column to Columns collection.
   ItemsGrid.Columns.AddAt(2, AddColumn);

}

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft