GridView.RowHeaderColumn Property (System.Web.UI.WebControls)

Switch View :

ScriptFree

.NET Framework Class Library

GridView.RowHeaderColumn Property

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.

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

Syntax

Visual Basic

<TypeConverterAttribute("System.Web.UI.Design.DataColumnSelectionConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")> _
Public Overridable Property RowHeaderColumn As String

[TypeConverterAttribute("System.Web.UI.Design.DataColumnSelectionConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public virtual string RowHeaderColumn { get; set; }

Visual C++

[TypeConverterAttribute(L"System.Web.UI.Design.DataColumnSelectionConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public:
virtual property String^ RowHeaderColumn {
	String^ get ();
	void set (String^ value);
}

[<TypeConverterAttribute("System.Web.UI.Design.DataColumnSelectionConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>]
abstract RowHeaderColumn : string with get, set
[<TypeConverterAttribute("System.Web.UI.Design.DataColumnSelectionConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>]
override RowHeaderColumn : string with get, set

ASP.NET

<asp:GridView RowHeaderColumn="String" />

Property Value

Type: System.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.

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.

Examples

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

Visual Basic



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



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

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Platforms

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.

Reference

GridView Class

System.Web.UI.WebControls Namespace

Caption

CaptionAlign

UseAccessibleHeader