Modifier

Partager via

GridView.RowHeaderColumn Property

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

Gets or sets the name of the column to use as the column header for the GridView control. This property is provided to make the control more accessible to users of assistive technology devices.

public:
 virtual property System::String ^ RowHeaderColumn { System::String ^ get(); void set(System::String ^ value); };
[System.ComponentModel.TypeConverter("System.Web.UI.Design.DataColumnSelectionConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public virtual string RowHeaderColumn { get; set; }
[System.ComponentModel.TypeConverter("System.Web.UI.Design.DataColumnSelectionConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public virtual string RowHeaderColumn { get; set; }
[<System.ComponentModel.TypeConverter("System.Web.UI.Design.DataColumnSelectionConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>]
member this.RowHeaderColumn : string with get, set
[<System.ComponentModel.TypeConverter("System.Web.UI.Design.DataColumnSelectionConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>]
member this.RowHeaderColumn : string with get, set
Public Overridable Property RowHeaderColumn As String

Property Value

String

The name of the column to use as the column header. The default is an empty string (""), which indicates that this property is not set.

Attributes
TypeConverterAttribute

Examples

The following example demonstrates how to use the RowHeaderColumn property to display a header column in a GridView control.


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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>GridView RowHeaderColumn Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>GridView RowHeaderColumn Example</h3>

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        allowpaging="true"
        rowheadercolumn="CustomerID"  
        runat="server">
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 
        runat="server"/>
        
    </form>
  </body>
</html>


<%@ Page language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>GridView RowHeaderColumn Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>GridView RowHeaderColumn Example</h3>

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        allowpaging="true"
        rowheadercolumn="CustomerID"  
        runat="server">
      </asp:gridview>
            
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 
        runat="server"/>
        
    </form>
  </body>
</html>

Remarks

In HTML, the header of a table can be associated with either a row or a column. The direction is specified by setting the scope attribute of the <th> elements. The GridView control has a built-in header row that can be displayed by setting the ShowHeader property to true. You can also optionally specify a header column (usually the first or last column in the GridView control) by setting this property. When this property is set, all cells in the column that corresponds to the specified field name are rendered as <th scope="row"> elements.

Note

Although the specified column is treated like a header, the HeaderStyle, ShowHeader, and UseAccessibleHeader properties do not apply to the header column.

The default rendering of the <th> element is preserved, rendering text as bold and centered horizontally. Developers can override the behavior of the <th> element using a cascading style sheet.

Note

This property works only with bound fields. It does not work with template fields.

Applies to

See also