Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

GridView.CaptionAlign Property

Gets or sets the horizontal or vertical position of the HTML caption element in a 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)

public virtual TableCaptionAlign CaptionAlign { get; set; }
/** @property */
public TableCaptionAlign get_CaptionAlign ()

/** @property */
public void set_CaptionAlign (TableCaptionAlign value)

public function get CaptionAlign () : TableCaptionAlign

public function set CaptionAlign (value : TableCaptionAlign)

Not applicable.

Property Value

One of the TableCaptionAlign values. The default is TableCaptionAlign.NotSet, which uses the browser's default setting.
Exception typeCondition

ArgumentOutOfRangeException

The specified value is not one of the TableCaptionAlign enumeration values.

Use the CaptionAlign property to specify the horizontal or vertical position of the HTML caption element in a GridView control. This property is provided to make the control more accessible to users of assistive technology devices.

This property is set using one of the TableCaptionAlign enumeration values. The following table lists the possible values.

Value

Description

TableCaptionAlign.Bottom

The caption element is aligned with the bottom of the table.

TableCaptionAlign.Left

The caption element is aligned with the left side of the table.

TableCaptionAlign.NotSet

The caption element's alignment is not set.

TableCaptionAlign.Right

The caption element is aligned with the right side of the table.

TableCaptionAlign.Top

The caption element is aligned with the top of the table.

NoteNote:

When this property is set to TableCaptionAlign.NotSet, the default value of the browser is used.

To specify the text for the HTML caption element, use the Caption property.

The following code example demonstrates how to use the CaptionAlign property to specify that the caption element for a GridView control is aligned with the top of the 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 Caption and CaptionAlign Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>GridView Caption and CaptionAlign Example</h3>

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        emptydatatext="No data available." 
        allowpaging="true"
        caption="Customer Information Table"
        captionalign="Top"   
        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>


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
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.