Calendar.DisplayMode Property

Definition

Namespace:

System.Windows.Controls

Assembly:

PresentationFramework.dll

Gets or sets a value that indicates whether the calendar displays a month, year, or decade.

public:
 property System::Windows::Controls::CalendarMode DisplayMode { System::Windows::Controls::CalendarMode get(); void set(System::Windows::Controls::CalendarMode value); };

public System.Windows.Controls.CalendarMode DisplayMode { get; set; }

member this.DisplayMode : System.Windows.Controls.CalendarMode with get, set

Public Property DisplayMode As CalendarMode

Property Value

CalendarMode

A value that indicates what length of time the Calendar should display.

Examples

The following example creates a calendar that displays the months in a year and handles the DisplayModeChanged event so that when the user clicks on a month or the year, the calendar does not change its DisplayMode.

Calendar yearCalendar = new Calendar();
yearCalendar.DisplayMode = CalendarMode.Year;
yearCalendar.DisplayModeChanged +=
    new EventHandler<CalendarModeChangedEventArgs>(Calendar_DisplayModeChanged);

// root is a Panel that is defined elswhere.
root.Children.Add(yearCalendar);

Dim yearCalendar As New Calendar()
yearCalendar.DisplayMode = CalendarMode.Year
AddHandler yearCalendar.DisplayModeChanged, AddressOf Calendar_DisplayModeChanged

' root is a Panel that is defined elswhere. 
root.Children.Add(yearCalendar)

<Calendar DisplayMode="Year" DisplayModeChanged="Calendar_DisplayModeChanged" />

private void Calendar_DisplayModeChanged(object sender,
                                         CalendarModeChangedEventArgs e)
{
    Calendar calObj = sender as Calendar;

    calObj.DisplayMode = CalendarMode.Year;
}

    Private Sub Calendar_DisplayModeChanged(ByVal sender As Object, ByVal e As CalendarModeChangedEventArgs)
        Dim calObj As Calendar = TryCast(sender, Calendar)

        calObj.DisplayMode = CalendarMode.Year
    End Sub

    Private Sub calendar1_Loaded(ByVal sender As System.Object, ByVal e As System.Windows.RoutedEventArgs)
        Dim cal = TryCast(sender, Calendar)
        cal.BlackoutDates.AddDatesInPast()
    End Sub

End Class

Remarks

A Calendar can display a month, a year, or a decade. The following table lists how the user navigates to each mode.

DisplayMode	Action
Month	To navigate to Year mode, click the month heading.
Year	To navigate to Decade mode, click the year heading. To navigate to Month mode, click one of the displayed months.
Decade	To navigate to Year mode, click one of the displayed years.

Dependency Property Information

Identifier field	DisplayModeProperty
Metadata properties set to true	BindsTwoWayByDefault