.NET Framework Class Library
ButtonFieldBase..::.ButtonType Property

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

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

Visual Basic (Declaration)
Public Overridable Property ButtonType As ButtonType
Visual Basic (Usage)
Dim instance As ButtonFieldBase
Dim value As ButtonType

value = instance.ButtonType

instance.ButtonType = value
C#
public virtual ButtonType ButtonType { get; set; }
Visual C++
public:
virtual property ButtonType ButtonType {
    ButtonType get ();
    void set (ButtonType value);
}
JScript
public function get ButtonType () : ButtonType
public function set ButtonType (value : ButtonType)

Property Value

Type: System.Web.UI.WebControls..::.ButtonType
One of the ButtonType values. The default is ButtonType.Link.
Exceptions

ExceptionCondition
ArgumentOutOfRangeException

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

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.

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.

Visual Basic
<%@ 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  >
<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>

C#
<%@ 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  >
<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>

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Tags :


Page view tracker