Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

CalendarBlackoutDatesCollection Class

.NET Framework 4

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

System.Object
  System.Collections.ObjectModel.Collection<CalendarDateRange>
    System.Collections.ObjectModel.ObservableCollection<CalendarDateRange>
      System.Windows.Controls.CalendarBlackoutDatesCollection

Namespace:  System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
C#
C++
F#
VB
Copy 
public sealed class CalendarBlackoutDatesCollection : ObservableCollection<CalendarDateRange>

XAML Values

oneOrMoreCalendarDateRanges

One or more object elements of type CalendarDateRange.

The CalendarBlackoutDatesCollection type exposes the following members.

  Name Description
Public method CalendarBlackoutDatesCollection Initializes a new instance of the CalendarBlackoutDatesCollection class.
Top
  Name Description
Public property Count Gets the number of elements actually contained in the Collection<T>. (Inherited from Collection<T>.)
Public property Item Gets or sets the element at the specified index. (Inherited from Collection<T>.)
Protected property Items Gets a IList<T> wrapper around the Collection<T>. (Inherited from Collection<T>.)
Top
  Name Description
Public method Add Adds an object to the end of the Collection<T>. (Inherited from Collection<T>.)
Public method AddDatesInPast Adds all dates before Today to the collection.
Protected method BlockReentrancy Disallows reentrant attempts to change this collection. (Inherited from ObservableCollection<T>.)
Protected method CheckReentrancy Checks for reentrant attempts to change this collection. (Inherited from ObservableCollection<T>.)
Public method Clear Removes all elements from the Collection<T>. (Inherited from Collection<T>.)
Protected method ClearItems Removes all items from the collection. (Inherited from ObservableCollection<T>.)
Public method Contains(T) Determines whether an element is in the Collection<T>. (Inherited from Collection<T>.)
Public method Contains(DateTime) Returns a value that represents whether this collection contains the specified date.
Public method Contains(DateTime, DateTime) Returns a value that represents whether this collection contains the specified range of dates.
Public method ContainsAny Returns a value that represents whether this collection contains any dates in the specified range of dates.
Public method CopyTo Copies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<T>.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an enumerator that iterates through the Collection<T>. (Inherited from Collection<T>.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Searches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<T>.)
Public method Insert Inserts an element into the Collection<T> at the specified index. (Inherited from Collection<T>.)
Protected method InsertItem Inserts an item into the collection at the specified index. (Inherited from ObservableCollection<T>.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Move Moves the item at the specified index to a new location in the collection. (Inherited from ObservableCollection<T>.)
Protected method MoveItem Moves the item at the specified index to a new location in the collection. (Inherited from ObservableCollection<T>.)
Protected method OnCollectionChanged Raises the CollectionChanged event with the provided arguments. (Inherited from ObservableCollection<T>.)
Protected method OnPropertyChanged Raises the PropertyChanged event with the provided arguments. (Inherited from ObservableCollection<T>.)
Public method Remove Removes the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<T>.)
Public method RemoveAt Removes the element at the specified index of the Collection<T>. (Inherited from Collection<T>.)
Protected method RemoveItem Removes the item at the specified index of the collection. (Inherited from ObservableCollection<T>.)
Protected method SetItem Replaces the element at the specified index. (Inherited from ObservableCollection<T>.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public event CollectionChanged Occurs when an item is added, removed, changed, moved, or the entire list is refreshed. (Inherited from ObservableCollection<T>.)
Protected event PropertyChanged Occurs when a property value changes. (Inherited from ObservableCollection<T>.)
Top
  Name Description
Explicit interface implemetation Private method ICollection.CopyTo Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from Collection<T>.)
Explicit interface implemetation Private property ICollection<T>.IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. (Inherited from Collection<T>.)
Explicit interface implemetation Private property ICollection.IsSynchronized Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from Collection<T>.)
Explicit interface implemetation Private property ICollection.SyncRoot Gets an object that can be used to synchronize access to the ICollection. (Inherited from Collection<T>.)
Explicit interface implemetation Private method IEnumerable.GetEnumerator Returns an enumerator that iterates through a collection. (Inherited from Collection<T>.)
Explicit interface implemetation Private method IList.Add Adds an item to the IList. (Inherited from Collection<T>.)
Explicit interface implemetation Private method IList.Contains Determines whether the IList contains a specific value. (Inherited from Collection<T>.)
Explicit interface implemetation Private method IList.IndexOf Determines the index of a specific item in the IList. (Inherited from Collection<T>.)
Explicit interface implemetation Private method IList.Insert Inserts an item into the IList at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetation Private property IList.IsFixedSize Gets a value indicating whether the IList has a fixed size. (Inherited from Collection<T>.)
Explicit interface implemetation Private property IList.IsReadOnly Gets a value indicating whether the IList is read-only. (Inherited from Collection<T>.)
Explicit interface implemetation Private property IList.Item Gets or sets the element at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetation Private method IList.Remove Removes the first occurrence of a specific object from the IList. (Inherited from Collection<T>.)
Explicit interface implemetation Private event INotifyPropertyChanged.PropertyChanged Occurs when a property value changes. (Inherited from ObservableCollection<T>.)
Top

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.

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

C#
VB
Copy 

// 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);
XAML
Copy 

<!-- 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

Calendar with dates that cannot be selected.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ