CalendarBlackoutDatesCollection Class

Definition

Namespace:

System.Windows.Controls

Assembly:

PresentationFramework.dll

Represents a collection of non-selectable dates in a Calendar.

public ref class CalendarBlackoutDatesCollection sealed : System::Collections::ObjectModel::ObservableCollection<System::Windows::Controls::CalendarDateRange ^>

public sealed class CalendarBlackoutDatesCollection : System.Collections.ObjectModel.ObservableCollection<System.Windows.Controls.CalendarDateRange>

type CalendarBlackoutDatesCollection = class
    inherit ObservableCollection<CalendarDateRange>

Public NotInheritable Class CalendarBlackoutDatesCollection
Inherits ObservableCollection(Of CalendarDateRange)

Inheritance

Object

Collection<T>

ObservableCollection<CalendarDateRange>

CalendarBlackoutDatesCollection

Examples

The following example creates a Calendar in code and markup that has some dates that cannot be selected.

  // Create a Calendar that displays dates through
  // Januarary 31, 2009 and has dates that are not selectable.
  Calendar calendarWithBlackoutDates = new Calendar();
  calendarWithBlackoutDates.IsTodayHighlighted = false;
  calendarWithBlackoutDates.DisplayDate = new DateTime(2009, 1, 1);
  calendarWithBlackoutDates.DisplayDateEnd = new DateTime(2009, 1, 31);
  calendarWithBlackoutDates.SelectionMode = CalendarSelectionMode.MultipleRange;

  // Add the dates that are not selectable.
  calendarWithBlackoutDates.BlackoutDates.Add(
      new CalendarDateRange(new DateTime(2009, 1, 2), new DateTime(2009, 1, 4)));
  calendarWithBlackoutDates.BlackoutDates.Add(
      new CalendarDateRange(new DateTime(2009, 1, 9)));
  calendarWithBlackoutDates.BlackoutDates.Add(
      new CalendarDateRange(new DateTime(2009, 1, 16)));
  calendarWithBlackoutDates.BlackoutDates.Add(
      new CalendarDateRange(new DateTime(2009, 1, 23), new DateTime(2009, 1, 25)));
  calendarWithBlackoutDates.BlackoutDates.Add(
      new CalendarDateRange(new DateTime(2009, 1, 30)));

  // Add the selected dates.
  calendarWithBlackoutDates.SelectedDates.Add(
      new DateTime(2009, 1, 5));
  calendarWithBlackoutDates.SelectedDates.AddRange(
      new DateTime(2009, 1, 12), new DateTime(2009, 1, 15));
  calendarWithBlackoutDates.SelectedDates.Add(
      new DateTime(2009, 1, 27));

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

' Create a Calendar that displays dates through 
' Januarary 31, 2009 and has dates that are not selectable. 
Dim calendarWithBlackoutDates As New Calendar()
calendarWithBlackoutDates.IsTodayHighlighted = False
calendarWithBlackoutDates.DisplayDate = New DateTime(2009, 1, 1)
calendarWithBlackoutDates.DisplayDateEnd = New DateTime(2009, 1, 31)
calendarWithBlackoutDates.SelectionMode = CalendarSelectionMode.MultipleRange

' Add the dates that are not selectable. 
calendarWithBlackoutDates.BlackoutDates.Add(New CalendarDateRange(New DateTime(2009, 1, 2), New DateTime(2009, 1, 4)))
calendarWithBlackoutDates.BlackoutDates.Add(New CalendarDateRange(New DateTime(2009, 1, 9)))
calendarWithBlackoutDates.BlackoutDates.Add(New CalendarDateRange(New DateTime(2009, 1, 16)))
calendarWithBlackoutDates.BlackoutDates.Add(New CalendarDateRange(New DateTime(2009, 1, 23), New DateTime(2009, 1, 25)))
calendarWithBlackoutDates.BlackoutDates.Add(New CalendarDateRange(New DateTime(2009, 1, 30)))

' Add the selected dates. 
calendarWithBlackoutDates.SelectedDates.Add(New DateTime(2009, 1, 5))
calendarWithBlackoutDates.SelectedDates.AddRange(New DateTime(2009, 1, 12), New DateTime(2009, 1, 15))
calendarWithBlackoutDates.SelectedDates.Add(New DateTime(2009, 1, 27))

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

<!-- Create a Calendar that displays dates through
     Januarary 31, 2009 and has dates that are not selectable. -->
<Calendar Margin="20" SelectionMode="MultipleRange"  
          IsTodayHighlighted="false" 
          DisplayDate="1/1/2009"
          DisplayDateEnd="1/31/2009"
          xmlns:sys="clr-namespace:System;assembly=mscorlib">

  <Calendar.BlackoutDates>
    <CalendarDateRange Start="1/2/2009" End="1/4/2009"/>
    <CalendarDateRange Start="1/9/2009" End="1/9/2009"/>
    <CalendarDateRange Start="1/16/2009" End="1/16/2009"/>
    <CalendarDateRange Start="1/23/2009" End="1/25/2009"/>
    <CalendarDateRange Start="1/30/2009" End="1/30/2009"/>
  </Calendar.BlackoutDates>

  <Calendar.SelectedDates>
    <sys:DateTime>1/5/2009</sys:DateTime>
    <sys:DateTime>1/12/2009</sys:DateTime>
    <sys:DateTime>1/14/2009</sys:DateTime>
    <sys:DateTime>1/13/2009</sys:DateTime>
    <sys:DateTime>1/15/2009</sys:DateTime>
    <sys:DateTime>1/27/2009</sys:DateTime>
    <sys:DateTime>4/2/2009</sys:DateTime>
  </Calendar.SelectedDates>
</Calendar>

The preceding example produces output that is similar to the following illustration.

Calendar with dates that cannot be selected

Remarks

The CalendarBlackoutDatesCollection contains CalendarDateRange objects that specify multiple dates that cannot be selected by a user. To make all past dates not selectable, you can use the AddDatesInPast method.

XAML Property Element Usage

<object>  
  <object.property>  
    oneOrMoreCalendarDateRanges  
  </object.property>  
</object>  

XAML Values

oneOrMoreCalendarDateRanges
One or more object elements of type CalendarDateRange.

Constructors

CalendarBlackoutDatesCollection(Calendar)

Initializes a new instance of the CalendarBlackoutDatesCollection class.

Properties

Count	Gets the number of elements actually contained in the Collection<T>. (Inherited from Collection<T>)
Item[Int32]	Gets or sets the element at the specified index. (Inherited from Collection<T>)
Items	Gets a IList<T> wrapper around the Collection<T>. (Inherited from Collection<T>)

Methods

Add(T)	Adds an object to the end of the Collection<T>. (Inherited from Collection<T>)
AddDatesInPast()	Adds all dates before Today to the collection.
BlockReentrancy()	Disallows reentrant attempts to change this collection. (Inherited from ObservableCollection<T>)
CheckReentrancy()	Checks for reentrant attempts to change this collection. (Inherited from ObservableCollection<T>)
Clear()	Removes all elements from the Collection<T>. (Inherited from Collection<T>)
ClearItems()	Removes all items from the collection. (Inherited from ObservableCollection<T>)
Contains(DateTime, DateTime)	Returns a value that represents whether this collection contains the specified range of dates.
Contains(DateTime)	Returns a value that represents whether this collection contains the specified date.
Contains(T)	Determines whether an element is in the Collection<T>. (Inherited from Collection<T>)
ContainsAny(CalendarDateRange)	Returns a value that represents whether this collection contains any dates in the specified range of dates.
CopyTo(T[], Int32)	Copies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<T>)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator()	Returns an enumerator that iterates through the Collection<T>. (Inherited from Collection<T>)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IndexOf(T)	Searches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<T>)
Insert(Int32, T)	Inserts an element into the Collection<T> at the specified index. (Inherited from Collection<T>)
InsertItem(Int32, T)	Inserts an item into the collection at the specified index. (Inherited from ObservableCollection<T>)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Move(Int32, Int32)	Moves the item at the specified index to a new location in the collection. (Inherited from ObservableCollection<T>)
MoveItem(Int32, Int32)	Moves the item at the specified index to a new location in the collection. (Inherited from ObservableCollection<T>)
OnCollectionChanged(NotifyCollectionChangedEventArgs)	Raises the CollectionChanged event with the provided arguments. (Inherited from ObservableCollection<T>)
OnPropertyChanged(PropertyChangedEventArgs)	Raises the PropertyChanged event with the provided arguments. (Inherited from ObservableCollection<T>)
Remove(T)	Removes the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<T>)
RemoveAt(Int32)	Removes the element at the specified index of the Collection<T>. (Inherited from Collection<T>)
RemoveItem(Int32)	Removes the item at the specified index of the collection. (Inherited from ObservableCollection<T>)
SetItem(Int32, T)	Replaces the element at the specified index. (Inherited from ObservableCollection<T>)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Events

CollectionChanged	Occurs when an item is added, removed, or moved, or the entire list is refreshed. (Inherited from ObservableCollection<T>)
PropertyChanged	Occurs when a property value changes. (Inherited from ObservableCollection<T>)

Extension Methods