This topic has not yet been rated - Rate this topic

ButtonColumn Class

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

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

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)
public class ButtonColumn : DataGridColumn

The ButtonColumn type exposes the following members.

  Name Description
Public method ButtonColumn Initializes a new instance of the ButtonColumn class.
Top
  Name Description
Public property ButtonType Gets or sets the type of button to display in the ButtonColumn object.
Public property CausesValidation Gets or sets a value indicating whether validation is performed when a button in the ButtonColumn object is clicked.
Public property 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.
Public property DataTextField Gets or sets the field name from a data source to bind to the ButtonColumn object.
Public property DataTextFormatString Gets or sets the string that specifies the display format for the caption in each button.
Protected property DesignMode Gets a value that indicates whether the column is in design mode. (Inherited from DataGridColumn.)
Public property FooterStyle Gets the style properties for the footer section of the column. (Inherited from DataGridColumn.)
Public property FooterText Gets or sets the text displayed in the footer section of the column. (Inherited from DataGridColumn.)
Public property HeaderImageUrl Gets or sets the location of an image to display in the header section of the column. (Inherited from DataGridColumn.)
Public property HeaderStyle Gets the style properties for the header section of the column. (Inherited from DataGridColumn.)
Public property HeaderText Gets or sets the text displayed in the header section of the column. (Inherited from DataGridColumn.)
Protected property IsTrackingViewState Gets a value that determines whether the DataGridColumn object is marked to save its state. (Inherited from DataGridColumn.)
Public property ItemStyle Gets the style properties for the item cells of the column. (Inherited from DataGridColumn.)
Protected property Owner Gets the DataGrid control that the column is a member of. (Inherited from DataGridColumn.)
Public property 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.)
Public property Text Gets or sets the caption that is displayed in the buttons of the ButtonColumn object.
Public property ValidationGroup Gets or sets the group of validation controls for which the ButtonColumn object causes validation when it posts back to the server.
Protected property ViewState Gets the System.Web.UI.StateBag object that allows a column derived from the DataGridColumn class to store its properties. (Inherited from DataGridColumn.)
Public property Visible Gets or sets a value that indicates whether the column is visible in the DataGrid control. (Inherited from DataGridColumn.)
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method FormatDataTextValue Converts the specified value to the format that is indicated by the DataTextFormatString property.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Initialize Resets the ButtonColumn object to its initial state. (Overrides DataGridColumn.Initialize().)
Public method InitializeCell Resets a cell in the ButtonColumn object to its initial state. (Overrides DataGridColumn.InitializeCell(TableCell, Int32, ListItemType).)
Protected method LoadViewState Loads the state of the DataGridColumn object. (Inherited from DataGridColumn.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnColumnChanged Calls the DataGridDesigner.OnColumnsChanged method. (Inherited from DataGridColumn.)
Protected method SaveViewState Saves the current state of the DataGridColumn object. (Inherited from DataGridColumn.)
Public method ToString Returns the string representation of the column. (Inherited from DataGridColumn.)
Protected method 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.)
Top
  Name Description
Explicit interface implemetation Private property IStateManager.IsTrackingViewState Infrastructure. Gets a value that indicates whether the column is tracking view state changes. (Inherited from DataGridColumn.)
Explicit interface implemetation Private method IStateManager.LoadViewState Infrastructure. Loads previously saved state. (Inherited from DataGridColumn.)
Explicit interface implemetation Private method IStateManager.SaveViewState Infrastructure. Returns an object containing state changes. (Inherited from DataGridColumn.)
Explicit interface implemetation Private method IStateManager.TrackViewState Infrastructure. Starts tracking state changes. (Inherited from DataGridColumn.)
Top

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

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ