DetailsView.CaptionAlign Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

Type: System.Web.UI.WebControls.TableCaptionAlign

One of the TableCaptionAlign values. The default is TableCaptionAlign.NotSet.

Exception Condition
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 DetailsView 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.

Additional accessibility support for the DetailsView control is provided by the Caption property. Use the Caption property to specify the text to render in an HTML caption element in a DetailsView control.

The value of CaptionAlign is stored in view state.

The following code example demonstrates how to use the CaptionAlign property to specify that the HTML caption element in a DetailsView control should be rendered on the left side 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>DetailsView Caption and CaptionAlign Example</title>
</head>
<body>
    <form id="Form1" runat="server">

      <h3>DetailsView Caption and CaptionAlign Example</h3>

        <asp:detailsview id="CustomerDetailView"
          datasourceid="DetailsViewSource"
          datakeynames="CustomerID"
          autogeneraterows="true"
          allowpaging="true"
          caption="Customer Details"
          captionalign="Left"  
          runat="server">

          <headerstyle backcolor="Navy"
            forecolor="White"/>

        </asp:detailsview>

        <!-- 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="DetailsViewSource" runat="server" 
          ConnectionString=
            "<%$ ConnectionStrings:NorthWindConnectionString%>"
          InsertCommand="INSERT INTO [Customers]([CustomerID], 
            [CompanyName], [Address], [City], [PostalCode], [Country]) 
            VALUES (@CustomerID, @CompanyName, @Address, @City, 
            @PostalCode, @Country)"
          SelectCommand="Select [CustomerID], [CompanyName], 
            [Address], [City], [PostalCode], [Country] 
            From [Customers]">
        </asp:SqlDataSource>
    </form>
  </body>
</html>

.NET Framework
Available since 2.0
Return to top
Show: