• Article

Calendar.DisplayDate Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets or sets the date to display.

Namespace:  System.Windows.Controls
Assembly:  System.Windows.Controls (in System.Windows.Controls.dll)

Syntax

'Declaration
<TypeConverterAttribute(GetType(DateTimeTypeConverter))> _
Public Property DisplayDate As DateTime

[TypeConverterAttribute(typeof(DateTimeTypeConverter))]
public DateTime DisplayDate { get; set; }

<sdk:Calendar DisplayDate="dateTimeString"/>

XAML Values

  • dateTimeString
    A date specified in the format yyyy/mm/dd. The mm and dd components must always consist of two characters, with a leading zero if necessary. For instance, the month of May should be specified as 05.

Property Value

Type: System.DateTime
The date to display.

Exceptions

Exception Condition
ArgumentOutOfRangeException

The given date is not in the range specified by DisplayDateStart and DisplayDateEnd.

Remarks

Dependency property identifier field: DisplayDateProperty

This property allows the developer to specify a date to display. If this property is nulla null reference (Nothing in Visual Basic), SelectedDate is displayed. If SelectedDate is also nulla null reference (Nothing in Visual Basic), Today is displayed. The default is Today.

Examples

The following code sets up a Calendar with a particular range of displayable dates, and sets the currently selected and displayed date. This example is part of a larger example available in the Calendar overview.

' Sets a Calendar to display a range of dates from 1/10/2009 to 
' 4/18/2009. 2/15/2009 is selected, but 3/2009 is initially 
' displayed. 
cal.SelectedDate = New DateTime(2009, 2, 15)
cal.DisplayDate = New DateTime(2009, 3, 15)

' if DisplayDate is not set, the Calendar displays 
' the SelectedDate. 
cal.DisplayDateStart = New DateTime(2009, 1, 10)
cal.DisplayDateEnd = New DateTime(2009, 4, 18)

//Sets a Calendar to display a range of dates from 1/10/2009 to 
//4/18/2009.  2/15/2009 is selected, but 3/2009 is initially 
//displayed.
cal.SelectedDate = new DateTime(2009, 2, 15);
cal.DisplayDate = new DateTime(2009, 3, 15); //if DisplayDate is not set, the Calendar displays
//the SelectedDate.
cal.DisplayDateStart = new DateTime(2009, 1, 10);
cal.DisplayDateEnd = new DateTime(2009, 4, 18);

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.