ButtonFieldBase.ButtonType Property

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.

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

public:
 virtual property System::Web::UI::WebControls::ButtonType ButtonType { System::Web::UI::WebControls::ButtonType get(); void set(System::Web::UI::WebControls::ButtonType value); };

public virtual System.Web.UI.WebControls.ButtonType ButtonType { get; set; }

member this.ButtonType : System.Web.UI.WebControls.ButtonType with get, set

Public Overridable Property ButtonType As ButtonType

Property Value

ButtonType

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

Exceptions

ArgumentOutOfRangeException

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

Examples

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 xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ButtonFieldBase ButtonType Example</title>
</head>
<body>
  <form id="form1" runat="server">
  <div>

    <h3>ButtonFieldBase ButtonType Example</h3>

    <asp:label id="Message"
      forecolor="Red"
      runat="server"
      AssociatedControlID="AuthorsGridView" />
                    
    <!-- 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>

  </div>
  </form>
</body>
</html>


<%@ Page language="VB" %>

<script runat="server">

  Sub AuthorsGridView_RowCommand(ByVal sender As Object, ByVal e As GridViewCommandEventArgs)
  
    ' If multiple ButtonField column fields are used, use the
    ' CommandName property to determine which button was clicked.
    If e.CommandName = "Select" Then
    
      ' Convert the row index stored in the CommandArgument
      ' property to an Integer.
      Dim index As Integer = Convert.ToInt32(e.CommandArgument)
    
      ' Get the last name of the selected author from the appropriate
      ' cell in the GridView control.
      Dim selectedRow As GridViewRow = AuthorsGridView.Rows(index)
      Dim lastNameCell As TableCell = selectedRow.Cells(1)
      Dim lastName As String = lastNameCell.Text
    
      ' Display the selected author.
      Message.Text = "You selected " & lastName & "."
      
    End If
    
  End Sub
    
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ButtonFieldBase ButtonType Example</title>
</head>
<body>
  <form id="form1" runat="server">
  <div>
        
    <h3>ButtonFieldBase ButtonType Example</h3>

    <asp:label id="Message"
      forecolor="Red"
      runat="server"
      AssociatedControlID="AuthorsGridView"/>

    <!-- 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>

  </div>
  </form>
</body>
</html>

Remarks

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.

Applies to

Share via