This documentation is archived and is not being maintained.

ButtonFieldBase.ButtonType Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the button type to display in the button field.

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

public virtual ButtonType ButtonType { get; set; }
/** @property */
public ButtonType get_ButtonType ()

/** @property */
public void set_ButtonType (ButtonType value)

public function get ButtonType () : ButtonType

public function set ButtonType (value : ButtonType)

Property Value

One of the ButtonType values. The default is ButtonType.Link.

Exception typeCondition

ArgumentOutOfRangeException

The value for the ButtonType property is not one of the ButtonType values.

Use the ButtonType property to specify which type of button is displayed in a button field. The following table lists the available button types.

Button type value

Displays as

Button

A button control.

Image

A button with an image.

Link

A link.

The value of this property is stored in view state.

The following code example demonstrates how to use the ButtonType property to specify that buttons are displayed in the ButtonField object of a GridView control.


<%@ Page language="C#" %>

<script runat="server">

  void AuthorsGridView_RowCommand(Object sender, GridViewCommandEventArgs e)
  {
  
    // If multiple ButtonField column fields are used, use the
    // CommandName property to determine which button was clicked.
    if(e.CommandName=="Select")
    {
    
      // Convert the row index stored in the CommandArgument
      // property to an Integer.
      int index = Convert.ToInt32(e.CommandArgument);    
    
      // Get the last name of the selected author from the appropriate
      // cell in the GridView control.
      GridViewRow selectedRow = AuthorsGridView.Rows[index];
      TableCell lastNameCell = selectedRow.Cells[1];
      string lastName = lastNameCell.Text;  
    
      // Display the selected author.
      Message.Text = "You selected " + lastName + ".";
      
    }
    
  }
    
</script>

<html>
  <body>
    <form runat="server">
        
      <h3>ButtonFieldBase ButtonType Example</h3>
      
      <asp:label id="Message"
        forecolor="Red"
        runat="server"/>
                    
      <!-- Populate the Columns collection declaratively. -->
      <asp:gridview id="AuthorsGridView" 
        datasourceid="AuthorsSqlDataSource" 
        autogeneratecolumns="false"
        onrowcommand="AuthorsGridView_RowCommand" 
        runat="server">
                
        <columns>
                
          <asp:buttonfield buttontype="Button" 
            commandname="Select"
            headertext="Select Author" 
            text="Select"/>
          <asp:boundfield datafield="au_lname" 
            headertext="Last Name"/>
          <asp:boundfield datafield="au_fname" 
            headertext="First Name"/>
                
        </columns>
                
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects -->
      <!-- to the Pubs sample database.                        -->
      <asp:sqldatasource id="AuthorsSqlDataSource"  
        selectcommand="SELECT [au_lname], [au_fname] FROM [authors]"
        connectionstring="server=localhost;database=pubs;integrated security=SSPI"
        runat="server">
      </asp:sqldatasource>
            
    </form>
  </body>
</html>


Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Show: