SelectedDatesCollection Class

Definition

Namespace:

System.Windows.Controls

Assembly:

PresentationFramework.dll

Represents a set of selected dates in a Calendar.

public ref class SelectedDatesCollection sealed : System::Collections::ObjectModel::ObservableCollection<DateTime>

public sealed class SelectedDatesCollection : System.Collections.ObjectModel.ObservableCollection<DateTime>

type SelectedDatesCollection = class
    inherit ObservableCollection<DateTime>

Public NotInheritable Class SelectedDatesCollection
Inherits ObservableCollection(Of DateTime)

Inheritance

Object

Collection<T>

ObservableCollection<DateTime>

SelectedDatesCollection

Examples

The following example creates a Calendar that has multiple ranges of dates 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>

Remarks

Dates can be added to the SelectedDates property of a Calendar. Depending on the value of the Calendar.SelectionMode property, adding a date or a range to the SelectedDatesCollection may cause it to be cleared. The following table lists how CalendarSelectionMode affects the SelectedDates property.

CalendarSelectionMode	Effect on SelectedDates
None	No selections are allowed. SelectedDate cannot be set and no values can be added to SelectedDates.
SingleDate	Only a single date can be selected, either by setting SelectedDate or the first value in SelectedDates. AddRange cannot be used.
SingleRange	A single range of dates can be selected. Setting SelectedDate, adding a date individually to SelectedDates, or using AddRange will clear all previous values from SelectedDates.
MultipleRange	Multiple non-contiguous ranges 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 ranges can then be added. Adding a range that includes some dates that are already selected or overlaps with another range results in the union of the ranges and does not cause an exception.

Constructors

SelectedDatesCollection(Calendar)

Initializes a new instance of the SelectedDatesCollection 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>)
AddRange(DateTime, DateTime)	Adds all the dates in the specified range, which includes the first and last dates, 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(T)	Determines whether an element is in the Collection<T>. (Inherited from Collection<T>)
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