Post
Ask Question

Working with WPF Calendar

A Calendar control is used to create a visual calendar that let users pick a date and fire an event on the selection of the date. This article demonstrates how to create and use a Calendar control in WPF using XAML and C#.

Creating a Calendar

The Calendar element represents a WPF calendar control in XAML.

  1. <Calendar/>  

The Calendar control is defined in the System.Windows.Controls namespace. When you drag and drop a Calendar control from Toolbox to the page, the XAML code will look like following code where you can see a Calendar XAML element is added within the Grid element and its Width, Height, Name, and VerticalAlignment and HorizontalAlignment attributes are set. 

  1. <Grid>  
  2.    <Calendar Height="170" HorizontalAlignment="Left" Margin="58,32,0,0"  
  3.    Name="calendar1" VerticalAlignment="Top" Width="180" />  
  4. </Grid>  

The default view of the Calendar control looks like Figure 1. 

WPF Calendar

Figure 1

The Width and Height attributes of the Calendar element represent the width and the height of a Calendar. The Content attribute represents the text of a Calendar. The Name attribute represents the name of the control, which is a unique identifier of a control. 

The code snippet in Listing 1 creates a Calendar control and sets the name, height, and width properties of a Calendar control.

  1. <Calendar Name=" MonthlyCalendar" Height="30" Width="100">  
  2. </Calendar>  

Listing 1

Display Modes

The DisplayMode property of the Calendar class represents the format of display of a Calendar, which can be a month, year, or decade. Month is the default mode. By setting the DisplayMode to Year and Decade generates Figure 2 and Figure 3 respectively.

WPF Calendar Month View

Figure 2

WPF Calendar Yearly View

Figure 3

The Month view that is also the default view looks like Figure 4.

WPF Calendar Selected Dates

Figure 4

If you take an example of the Decade, and click on year 2008 in Figure 3, you will get another Calendar format with all months in year 2008 and if you click on any month, you will eventually get the month view of the Calendar.

The following code snippet sets the DisplayMode property to Decade.

  1. <Calendar DisplayMode="Decade">  
  2. </Calendar>  

Selection Modes and Selection Dates

The SelectedDate property represents the currently selected date. If multiple dates selection is true, the SelectedDates property represents a collection of currently selected dates.

The SelectionMode of type CalendarSelectionMode enumeration represents the selection mode of calendar. Table 1 describes the CalendarSelectionMode enumeration and its members.

CalendarSelectionMode Description
NoneNo selections are allowed.
SingleDateOnly a single date can beselected, either by setting SelectedDate or the first value in SelectedDates. AddRange cannot be used.
SingleRangeA single range of dates canbe selected. Setting SelectedDate, adding a date individually to SelectedDates, or using AddRange will clear allprevious values from SelectedDates.
MultipleRangeMultiple non-contiguousranges of dates can be selected. Adding a date individually to SelectedDates or using AddRange will not clear SelectedDates. Setting SelectedDate will still clear SelectedDates, but additional dates or range can then beadded. Adding a range that includes some dates that are already selected oroverlaps with another range results in the union of the ranges and does notcause an exception.

The following code snippet sets the SelectionMode property to single range.

  1. <Calendar SelectionMode="SingleRange">  
  2. </Calendar>  

BlackoutDates

The BlackoutDates property of the Calendar class represents a collection of dates that are not available for selection. All non selection dates are marked by a cross. For example, say in March month of year 2010, we would like to block dates from Jan 1st to Jan 8th and then all Mondays. The final calendar should look like Figure 5.

BlackoutDates

Figure 5

The following code snippet adds backout dates to a Calendar.

  1. <Calendar.BlackoutDates>  
  2.     <CalendarDateRange Start="3/1/2010" End="3/7/2010" />  
  3.     <CalendarDateRange Start="3/8/2010" End="3/8/2010" />  
  4.     <CalendarDateRange Start="3/15/2010" End="3/15/2010" />  
  5.     <CalendarDateRange Start="3/22/2010" End="3/22/2010" />  
  6.     <CalendarDateRange Start="3/29/2010" End="3/29/2010" />  
  7. </Calendar.BlackoutDates>  

We can achieve this by adding code listed in Listing 2. As you can see from Listing 3, the BlackoutDates.Add method takes a CalendarDateRange object, which is a collection of two DateTime objects. The first date is the start date of the range and second date is the end date of the date range.

  1. private void SetBlackOutDates() {  
  2.     MonthlyCalendar.BlackoutDates.Add(new CalendarDateRange(new DateTime(2010, 3, 1), new DateTime(2010, 3, 7)));  
  3.     MonthlyCalendar.BlackoutDates.Add(new CalendarDateRange(new DateTime(2010, 3, 8), new DateTime(2010, 3, 8)));  
  4.     MonthlyCalendar.BlackoutDates.Add(new CalendarDateRange(new DateTime(2010, 3, 15), new DateTime(2010, 3, 15)));  
  5.     MonthlyCalendar.BlackoutDates.Add(new CalendarDateRange(new DateTime(2010, 3, 22), new DateTime(2010, 3, 22)));  
  6.     MonthlyCalendar.BlackoutDates.Add(new CalendarDateRange(new DateTime(2010, 3, 29), new DateTime(2010, 3, 29)));  
  7. }  

Listing 2

DisplayDateStart and DisplayDateEnd

The Calendar control allows you to set the start and end display dates by using the DisplayDateStart and DisplayDateEnd properties. If you see Figure 5 in the previous section, you may notice the March 2010 month calendar display start with March 01, 2010 date. But now what if you want to display dates for March 2010 month only? We can use the DisplayStartDate and DisplayEndDate properties to control the start and end dates of a month.

DisplayDate property represents the current date to display.

The following code snippet sets the DisplayDate, DisplayDateStart and DisplayDateEnd attributes of Calendar element in XAML.

  1. <Calendar Name="MonthlyCalendar"  
  2.    SelectionMode="MultipleRange"   
  3.    DisplayDate="3/1/2010"  
  4.    DisplayDateStart="3/1/2010"  
  5.    DisplayDateEnd="3/31/2010"  
  6. />   

The code listed in Listing 3 makes sure the start date is March 01, 2010 and end date is March 31, 2010. The current selected date is March 05.

  1. private void SetDisplayDates()  
  2. {  
  3.     MonthlyCalendar.DisplayDate = new DateTime(2010, 3, 5);  
  4.     MonthlyCalendar.DisplayDateStart = new DateTime(2010, 3, 1);  
  5.     MonthlyCalendar.DisplayDateEnd = new DateTime(2010, 3, 31);  
  6. }  

Listing 3

The new calendar looks like Figure 6.

new calendar

Figure 6

FirstDayOfWeek and IsTodayHighlighted

By default, Sunday is the first day of week. If you would like to change it, you use FirstDayOfWeek property. The IsTodayHightlighted property is used to make today highlighted.

The following code snippet sets the FirstDayOfWeek to Tuesday and makes today highlighted.

  1. <Calendar Name="MonthlyCalendar"  
  2.    SelectionMode="MultipleRange"  
  3.    DisplayDate="3/5/2010"  
  4.    DisplayDateStart="3/1/2010"  
  5.    DisplayDateEnd="3/31/2010"  
  6.    FirstDayOfWeek="Tuesday"  
  7.    IsTodayHighlighted="True"  
  8. xmlns:sys="clr-namespace:System;assembly=mscorlib" Margin="15,39,88,19">  

The following code snippet sets the FirstDayOfWeek to Tuesday and makes today highlighted in WPF.

  1. MonthlyCalendar.FirstDayOfWeek = DayOfWeek.Tuesday;  
  2. MonthlyCalendar.IsTodayHighlighted = true;  

The new calendar looks like Figure 7, where you can see the start day of the week us Tuesday.

FirstDayOfWeek and IsTodayHighlighted

Figure 7

Selected Date and Selected Dates

SelectedDate property represents the current selected date. If multiple date selection is true, then SelectedDates property represents all selected dates in a Calendar. The following code snippet sets the SelectedDates in XAML at design-time.

  1. <Calendar Name="MonthlyCalendar" SelectionMode="MultipleRange" DisplayDate="3/5/2010" DisplayDateStart="3/1/2010" DisplayDateEnd="3/31/2010" FirstDayOfWeek="Tuesday" IsTodayHighlighted="True" xmlns:sys="clr-namespace:System;assembly=mscorlib" Margin="15,39,88,19">  
  2.     <Calendar.SelectedDates>  
  3.         <sys:DateTime>3/5/2010</sys:DateTime>  
  4.         <sys:DateTime>3/15/2010</sys:DateTime>  
  5.         <sys:DateTime>3/25/2010</sys:DateTime>  
  6.     </Calendar.SelectedDates>  
  7. </Calendar>  

The selected dates in a Calendar looks like Figure 8 where you can see March 5th, 15th, and 25th have a light blue background and represents the selected dates.

selected dates in a Calendar

Figure 8

The following code snippet sets the SelectedDates property in WPF at run-time.

  1. private void AddSelectedDates()   
  2. {  
  3.     MonthlyCalendar.SelectedDates.Add(new DateTime(2010, 3, 5));  
  4.     MonthlyCalendar.SelectedDates.Add(new DateTime(2010, 3, 15));  
  5.     MonthlyCalendar.SelectedDates.Add(new DateTime(2010, 3, 25));  
  6. }  

Note
If you set selected dates to any of the blockout dates, you will see parser in XAML will through an error like Figure 9. 

Parser in XAML

Figure 9

Calendar Events

Besides the normal control events, the Calendar control has three events calendar related events. These events are the DisplayDateChanged, DisplayModeChanged, and SelectedDatesChanged. The DisplayDateChanged event is fired where the DisplayDate property is changed. The DisplayModeChanged event is fired when the DisplayMode property is changed. The SelectedDatesChanged event is fired when the SelectedDate or SelectedDates properties are changed. The following code snippet sets these three events attributes.

  1. <Calendar SelectionMode="SingleRange"  
  2.    Name="MonthlyCalendar"  
  3.       SelectedDatesChanged="MonthlyCalendar_SelectedDatesChanged"  
  4.          DisplayDateChanged="MonthlyCalendar_DisplayDateChanged"  
  5.          DisplayModeChanged="MonthlyCalendar_DisplayModeChanged"  
  6.       HorizontalAlignment="Left"  
  7.       VerticalAlignment="Top"  
  8.     Margin="10,10,0,0">  
  9. </Calendar>  

The code behind for these events looks like Listing 4.

  1. private void MonthlyCalendar_SelectedDatesChanged(object sender, SelectionChangedEventArgs e) {}  
  2. private void MonthlyCalendar_DisplayDateChanged(object sender, CalendarDateChangedEventArgs e) {}  
  3. private void MonthlyCalendar_DisplayModeChanged(object sender, CalendarModeChangedEventArgs e) {}  

Listing 4

Normally, on a date selection, you may want to capture that event and know what the current selected date is. Now how about we add a TextBox control to the page and on the date selection, we are going to set the text of the TextBox to the currently selected date.

We add the following code to the XAML just below the Calendar control.

  1. <TextBox Width="200" Height="30" VerticalAlignment="Bottom" HorizontalAlignment="Left" Margin="10,10,10,10" x:Name="SelectedDateTextBox">  
  2. </TextBox>  

On the SelectedDateChanged event handler, we set the TextBox.Text property to the SelectedDate property of the Calendar control as you can see from code in Listing 5.

  1. private void MonthlyCalendar_SelectedDatesChanged(object sender,  
  2. SelectionChangedEventArgs e)  
  3. {  
  4.    SelectedDateTextBox.Text = MonthlyCalendar.SelectedDate.ToString();  
  5. }  

Listing 5

Now when you run the application, you will see output looks like Figure 10. When you select a date in the Calendar, it will be displayed in the Textbox.

Calendar Events

Figure 10

Formatting a Calendar

How about we create a Calendar control with a border formatting, background, and foreground of the Calendar?

The BorderBrush property of the Calendar sets a brush to draw the border of a Calendar. You may use any brush to fill the border. The following code snippet uses a linear gradient brush to draw the border with a combination of red and blue color.

  1. <Calendar.BorderBrush>  
  2.     <LinearGradientBrush StartPoint="0,0" EndPoint="1,1">  
  3.         <GradientStop Color="Blue" Offset="0" />  
  4.         <GradientStop Color="Red" Offset="1.0" />  
  5.     </LinearGradientBrush>  
  6. </Calendar.BorderBrush>  

The Background and Foreground properties of the Calendar set the background and foreground colors of a Calendar. You may use any brush to fill the border. The following code snippet uses linear gradient brushes to draw the background and foreground of a Calendar.

  1. <Calendar.Background>  
  2.     <LinearGradientBrush StartPoint="0,0" EndPoint="1,1">  
  3.         <GradientStop Color="Blue" Offset="0.1" />  
  4.         <GradientStop Color="Orange" Offset="0.25" />  
  5.         <GradientStop Color="Green" Offset="0.75" />  
  6.         <GradientStop Color="Red" Offset="1.0" />  
  7.     </LinearGradientBrush>  
  8. </Calendar.Background>  
  9. <Calendar.Foreground>  
  10.     <LinearGradientBrush StartPoint="0,0" EndPoint="1,1">  
  11.         <GradientStop Color="Black" Offset="0.25" />  
  12.         <GradientStop Color="Green" Offset="1.0" />  
  13.     </LinearGradientBrush>  
  14. </Calendar.Foreground>  

The new Calendar looks like Figure 11.

Formatting a Calendar

Figure 11

Setting Image as Background of a Calendar

To set an image as background of a Calendar, we can set an image as the Background of the Calendar. The following code snippet sets the background of a Calendar to an image. The code also sets the opacity of the image.

  1. <Calendar.Background>  
  2.    <ImageBrush ImageSource="Garden.jpg" Opacity="0.3"/>  
  3. </Calendar.Background>  

The new output looks like Figure 12.

Setting Image as Background of a Calendar
Figure 12

Creating a Calendar Dynamically

The code listed in Listing 6 creates a Calendar control programmatically. First, it creates a Calendar object and sets its DisplayMode and SelectedMode and other properties and later the Calendar is added to the LayoutRoot.

  1. private void CreateDynamicCalendar() {  
  2.     Calendar MonthlyCalendar = new Calendar();  
  3.     MonthlyCalendar.Name = "MonthlyCalendar";  
  4.     MonthlyCalendar.Width = 300;  
  5.     MonthlyCalendar.Height = 400;  
  6.     MonthlyCalendar.Background = Brushes.LightBlue;  
  7.     MonthlyCalendar.DisplayMode = CalendarMode.Month;  
  8.     MonthlyCalendar.SelectionMode = CalendarSelectionMode.SingleRange;  
  9.     MonthlyCalendar.DisplayDateStart = new DateTime(2010, 3, 1);  
  10.     MonthlyCalendar.DisplayDateEnd = new DateTime(2010, 3, 31);  
  11.     MonthlyCalendar.SelectedDates.Add(new DateTime(2010, 3, 5));  
  12.     MonthlyCalendar.SelectedDates.Add(new DateTime(2010, 3, 15));  
  13.     MonthlyCalendar.SelectedDates.Add(new DateTime(2010, 3, 25));  
  14.     MonthlyCalendar.FirstDayOfWeek = DayOfWeek.Monday;  
  15.     MonthlyCalendar.IsTodayHighlighted = true;  
  16.     LayoutRoot.Children.Add(MonthlyCalendar);  
  17. }  

Listing 6

Summary

In this article, I discussed how we can create a Calendar control in WPF and C#. We also saw how to set display modes, selection modes, blackout dates, selected dates, border, background, and foreground properties. After that, we saw you to set an image as the background of a Calendar. In the end of this article, we saw how to create a Calendar dynamically.


Similar Articles
Mindcracker
Founded in 2003, Mindcracker is the authority in custom software development and innovation. We put best practices into action. We deliver solutions based on consumer and industry analysis.