Export (0) Print
Expand All
Expand Minimize

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)

'Declaration
Public Overridable Property CaptionAlign As TableCaptionAlign
<asp:GridView CaptionAlign="TableCaptionAlign" />

Property Value

Type: System.Web.UI.WebControls.TableCaptionAlign
One of the TableCaptionAlign values. The default is TableCaptionAlign.NotSet, which uses the browser's default setting.

ExceptionCondition
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 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="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 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>

.NET Framework

Supported in: 4.5.3, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft