Export (0) Print
Expand All

TableHeaderRow Class

Represents a heading row in a Table control.

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

'Declaration
Public Class TableHeaderRow
	Inherits TableRow
'Usage
Dim instance As TableHeaderRow

public class TableHeaderRow extends TableRow
public class TableHeaderRow extends TableRow
Not applicable.

The TableHeaderRow class represents a heading row in a Table control. This class supports displaying tables on devices with a limited screen size. On these devices, a table with many columns and rows must be rendered across multiple pages. Adding a TableHeaderRow to a Table control allows you to specify a heading row that is rendered as the first row on each page that displays a view of the table. For more information about the view formats for a table rendered on a device with a limited screen size, see Table.

A TableHeaderRow object can contain only TableCell objects. To add content to the TableHeaderRow, you must add one or more TableCell objects to the row. Then, set the Text property of each TableCell object in the row to specify the contents of each cell. Alternatively, you can add a control to a TableCell object to specify its contents.

You can programmatically manage the cells in the TableHeaderRow by using the Cells collection. The Cells collection is a collection of TableCell objects that represent the cells in the row.

The TableHeaderRow inherits properties from TableRow that allow you to control how the contents in the row are displayed. For example, you can use the HorizontalAlign and VerticalAlign properties to specify the alignment of the contents.

The following code example demonstrates the declarative syntax for creating a Table control that has a TableHeaderRow and a TableFooterRow.

<%@ 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 id="Head1" runat="server">
    <title>TableHeaderRow-TableFooterRow Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>

    <h3>TableHeaderRow and TableFooterRow Example</h3>

    <asp:Table id="Table1" runat="server" 
        CellPadding="3" 
        CellSpacing="0"
        GridLines="both"
        Caption="Sample Table">

        <asp:TableHeaderRow id="Table1HeaderRow" 
            BackColor="LightBlue"
            runat="server">
            <asp:TableHeaderCell 
                AssociatedHeaderCellID="Col1" 
                Scope="Column" 
                Text="Col1" />
            <asp:TableHeaderCell 
                AssociatedHeaderCellID="Col2" 
                Scope="Column" 
                Text="Col2" />
            <asp:TableHeaderCell 
                AssociatedHeaderCellID="Col3" 
                Scope="Column" 
                Text="Col3" />
        </asp:TableHeaderRow>              

        <asp:TableRow>
            <asp:TableCell Text="(0,0)" />
            <asp:TableCell Text="(0,1)" />
            <asp:TableCell Text="(0,2)" />
        </asp:TableRow>

        <asp:TableRow>
            <asp:TableCell Text="(1,0)" />
            <asp:TableCell Text="(1,1)" />
            <asp:TableCell Text="(1,2)" />
        </asp:TableRow> 

        <asp:TableFooterRow runat="server"
            BackColor="LightBlue">
            <asp:TableCell 
                ColumnSpan="3" 
                Text="The footer row." />
        </asp:TableFooterRow>                               
    </asp:Table>

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

The following code example demonstrates how to programmatically create a Table control that has a TableHeaderRow and a TableFooterRow.

NoteNote:

The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see ASP.NET Web Page Code Model.

<%@ page language="VB" %>
<%@ Import Namespace="System.Drawing" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
    Private Sub Page_Load(ByVal sender As Object, _
        ByVal e As System.EventArgs)

        ' Add rows to the table.
        Dim rowNum As Integer
        For rowNum = 0 To 100
            Dim tempRow As New TableRow
            Dim cellNum As Integer
            For cellNum = 0 To 2
                Dim tempCell As New TableCell
                tempCell.Text = _
                    String.Format("({0},{1})", rowNum, cellNum)
                tempRow.Cells.Add(tempCell)
            Next
            Table1.Rows.Add(tempRow)
        Next
        
        ' Create a TableHeaderRow.
        Dim headerRow As New TableHeaderRow
        headerRow.BackColor = Color.LightBlue

        ' Create TableCell objects to contain 
        ' the text for the header.
        Dim headerTableCell1 As New TableHeaderCell
        Dim headerTableCell2 As New TableHeaderCell
        Dim headerTableCell3 As New TableHeaderCell
        headerTableCell1.Text = "Column 1 Header"
        headerTableCell1.Scope = TableHeaderScope.Column
        headerTableCell1.AbbreviatedText = "Col 1 Head"
        headerTableCell2.Text = "Column 2 Header"
        headerTableCell2.Scope = TableHeaderScope.Column
        headerTableCell2.AbbreviatedText = "Col 2 Head"
        headerTableCell3.Text = "Column 3 Header"
        headerTableCell3.Scope = TableHeaderScope.Column
        headerTableCell3.AbbreviatedText = "Col 3 Head"

        ' Add the TableHeaderCell objects to the Cells
        ' collection of the TableHeaderRow.
        headerRow.Cells.Add(headerTableCell1)
        headerRow.Cells.Add(headerTableCell2)
        headerRow.Cells.Add(headerTableCell3)

        ' Add the TableHeaderRow as the first item 
        ' in the Rows collection of the table.
        Table1.Rows.AddAt(0, headerRow)

        ' Create a TableFooterRow.
        Dim footerRow As New TableFooterRow
        footerRow.BackColor = Color.LightBlue

        ' Create TableCell objects to contain the 
        ' text for the footer.
        Dim footerTableCell1 As New TableCell
        Dim footerTableCell2 As New TableCell
        Dim footerTableCell3 As New TableCell
        footerTableCell1.Text = "Column 1 footer"
        footerTableCell2.Text = "Column 2 footer"
        footerTableCell3.Text = "Column 3 footer"

        ' Add the TableCell objects to the Cells
        ' collection of the TableFooterRow.
        footerRow.Cells.Add(footerTableCell1)
        footerRow.Cells.Add(footerTableCell2)
        footerRow.Cells.Add(footerTableCell3)

        ' Add the TableFooterRow to the Rows
        ' collection of the table.
        Table1.Rows.Add(footerRow)
    End Sub
</script>

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

    <h3>TableHeaderRow and TableFooterRow Example</h3>
    <asp:table id="Table1" 
        CellPadding="3" 
        CellSpacing="0" 
        Gridlines="Both" 
        runat="server">
    </asp:table>

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

System.Object
   System.Web.UI.Control
     System.Web.UI.WebControls.WebControl
       System.Web.UI.WebControls.TableRow
        System.Web.UI.WebControls.TableHeaderRow

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft