TableHeaderCell.CategoryText 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 axis attribute of the HTML th element for the TableHeaderCell control.

public:
 virtual property cli::array <System::String ^> ^ CategoryText { cli::array <System::String ^> ^ get(); void set(cli::array <System::String ^> ^ value); };

[System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.StringArrayConverter))]
public virtual string[] CategoryText { get; set; }

[<System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.StringArrayConverter))>]
member this.CategoryText : string[] with get, set

Public Overridable Property CategoryText As String()

Property Value

String[]

An array of string values representing the TableHeaderCell categories.

Attributes: TypeConverterAttribute

Examples

The following code example demonstrates how to program the CategoryText property declaratively.

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

    <h1>TableHeaderCell Example</h1>
    <asp:table id="Table1" runat="server" 
        CellPadding="3" 
        CellSpacing="3" 
        BorderWidth="1" 
        GridLines="Both"> 
        <asp:TableHeaderRow ID="TableHeaderRow1" runat="server">
            <asp:TableHeaderCell runat="server" 
                ID="Column1Header"
                CategoryText="Column1"
                AbbreviatedText="Header 1"
                Scope="Column" 
                HorizontalAlign="Center" 
                VerticalAlign="Middle" 
                BackColor="LightGray">
                Column 1 Header
            </asp:TableHeaderCell>
            <asp:TableHeaderCell runat="server"
                ID="Column2Header"
                CategoryText="Column2,Column2Alternative"
                AbbreviatedText="Header 2"
                Scope="Column"
                HorizontalAlign="Center" 
                VerticalAlign="Middle"
                BackColor="LightGray">
                Column 2 Header
            </asp:TableHeaderCell>                                        
            <asp:TableHeaderCell runat="server" 
                ID="Column3Header"
                CategoryText="Column3"
                AbbreviatedText="Header 3"
                Scope="Column"
                HorizontalAlign="Center" 
                VerticalAlign="Middle"
                BackColor="LightGray">
                Column 3 Header
            </asp:TableHeaderCell>                                        
        </asp:TableHeaderRow>
        <asp:TableRow HorizontalAlign="Center">
            <asp:TableCell AssociatedHeaderCellID="Column1Header"
                HorizontalAlign="Left">
                (0,0)
            </asp:TableCell>
            <asp:TableCell 
                AssociatedHeaderCellID="Column2Header">
                (0,1)
            </asp:TableCell>
            <asp:TableCell 
                AssociatedHeaderCellID="Column3Header">
                (0,2)
            </asp:TableCell>
        </asp:TableRow>
        <asp:TableRow 
            HorizontalAlign="Center">
            <asp:TableCell 
                AssociatedHeaderCellID="Column1Header"
                HorizontalAlign="Left">
                (1,0)
            </asp:TableCell>
            <asp:TableCell 
                AssociatedHeaderCellID="Column2Header">
                (1,1)
            </asp:TableCell>
            <asp:TableCell 
                AssociatedHeaderCellID="Column3Header">
                (1,2)
            </asp:TableCell>
        </asp:TableRow>
        <asp:TableRow 
            HorizontalAlign="Center">
            <asp:TableCell 
                AssociatedHeaderCellID=
                    "Column1Header,Column2Header,Column3Header"
                ColumnSpan="3"
                HorizontalAlign="Left">
                (2,0)
            </asp:TableCell>
        </asp:TableRow>
    </asp:table>

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

    <h1>TableHeaderCell Example</h1>
    <asp:table id="Table1" runat="server" 
        CellPadding="3" 
        CellSpacing="3" 
        BorderWidth="1" 
        GridLines="Both"> 
        <asp:TableHeaderRow ID="TableHeaderRow1" runat="server">
            <asp:TableHeaderCell runat="server" 
                ID="Column1Header"
                CategoryText="Column1"
                AbbreviatedText="Header 1"
                Scope="Column" 
                HorizontalAlign="Center" 
                VerticalAlign="Middle" 
                BackColor="LightGray">
                Column 1 Header
            </asp:TableHeaderCell>
            <asp:TableHeaderCell runat="server"
                ID="Column2Header"
                CategoryText="Column2,Column2Alternative"
                AbbreviatedText="Header 2"
                Scope="Column"
                HorizontalAlign="Center" 
                VerticalAlign="Middle"
                BackColor="LightGray">
                Column 2 Header
            </asp:TableHeaderCell>                                        
            <asp:TableHeaderCell runat="server" 
                ID="Column3Header"
                CategoryText="Column3"
                AbbreviatedText="Header 3"
                Scope="Column"
                HorizontalAlign="Center" 
                VerticalAlign="Middle"
                BackColor="LightGray">
                Column 3 Header
            </asp:TableHeaderCell>                                        
        </asp:TableHeaderRow>
        <asp:TableRow HorizontalAlign="Center">
            <asp:TableCell AssociatedHeaderCellID="Column1Header"
                HorizontalAlign="Left">
                (0,0)
            </asp:TableCell>
            <asp:TableCell 
                AssociatedHeaderCellID="Column2Header">
                (0,1)
            </asp:TableCell>
            <asp:TableCell 
                AssociatedHeaderCellID="Column3Header">
                (0,2)
            </asp:TableCell>
        </asp:TableRow>
        <asp:TableRow 
            HorizontalAlign="Center">
            <asp:TableCell 
                AssociatedHeaderCellID="Column1Header"
                HorizontalAlign="Left">
                (1,0)
            </asp:TableCell>
            <asp:TableCell 
                AssociatedHeaderCellID="Column2Header">
                (1,1)
            </asp:TableCell>
            <asp:TableCell 
                AssociatedHeaderCellID="Column3Header">
                (1,2)
            </asp:TableCell>
        </asp:TableRow>
        <asp:TableRow 
            HorizontalAlign="Center">
            <asp:TableCell 
                AssociatedHeaderCellID=
                    "Column1Header,Column2Header,Column3Header"
                ColumnSpan="3"
                HorizontalAlign="Left">
                (2,0)
            </asp:TableCell>
        </asp:TableRow>
    </asp:table>

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

Remarks

The categories can be any string values that are pertinent to the table. The CategoryText property is rendered as the axis attribute of the HTML th element, which is used to group table cells into conceptual categories. The categories are rendered in HTML as a comma-delimited list.

The value of this property is stored in view state.

Applies to

Share via