Calendar.CaptionAlign Property
Definition
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 alignment of the text that is rendered as a caption for the calendar.
public:
virtual property System::Web::UI::WebControls::TableCaptionAlign CaptionAlign { System::Web::UI::WebControls::TableCaptionAlign get(); void set(System::Web::UI::WebControls::TableCaptionAlign value); };
public virtual System.Web.UI.WebControls.TableCaptionAlign CaptionAlign { get; set; }
member this.CaptionAlign : System.Web.UI.WebControls.TableCaptionAlign with get, set
Public Overridable Property CaptionAlign As TableCaptionAlign
Property Value
A TableCaptionAlign value that indicates the alignment of the caption.
Exceptions
The value specified is not one of the TableCaptionAlign values.
Examples
The following code example demonstrates how to use the CaptionAlign property to align a caption for a Calendar control.
<%@ Page Language="C#" AutoEventWireup="True" %>
<!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> Calendar Caption and Caption Align Example </title>
</head>
<body>
<form id="form1" runat="server">
<h3> Calendar Caption and Caption Align Example </h3>
<br /><br />
<asp:Calendar id="Calendar1"
ShowGridLines="True"
ShowTitle="True"
Caption="This calendar is used to demonstrate a calendar caption. It also shows
how the caption can be aligned to the calendar, in this case to the right edge of
the calendar."
CaptionAlign="right"
runat="server"/>
<br /><br />
</form>
</body>
</html>
<%@ Page Language="VB" AutoEventWireup="True" %>
<!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> Calendar Caption and Caption Align Example </title>
</head>
<body>
<form id="form1" runat="server">
<h3> Calendar Caption and Caption Align Example </h3>
<br /><br />
<asp:Calendar id="Calendar1"
ShowGridLines="True"
ShowTitle="True"
Caption="This calendar is used to demonstrate a calendar caption. It also shows
how the caption can be aligned to the calendar, in this case to the right edge of
the calendar."
CaptionAlign="right"
runat="server"/>
<br /><br />
</form>
</body>
</html>
Remarks
This property determines where the caption appears in relation to the Calendar control. The default value is NotSet, which lets the browser determine where to align the caption. The following table explains the relationship between the TableCaptionAlign value and the appearance of the caption.
TableCaptionAlign value | Appearance |
---|---|
Bottom |
The caption appears at the bottom of the calendar, with the text centered. |
Left |
The caption appears at the top of the calendar, with the text left-aligned. |
NotSet |
The caption alignment is not set and is determined by the browser. |
Right |
The caption appears at the top of the calendar, with the text right-aligned. |
Top |
The caption appears at the top of the calendar with the text centered. |