Export (0) Print
Expand All

CalendarBlackoutDatesCollection Class

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

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

'Declaration
Public NotInheritable Class CalendarBlackoutDatesCollection _
	Inherits ObservableCollection(Of CalendarDateRange)

XAML Values

oneOrMoreCalendarDateRanges

One or more object elements of type CalendarDateRange.

The CalendarBlackoutDatesCollection type exposes the following members.

  NameDescription
Public methodCalendarBlackoutDatesCollectionInitializes a new instance of the CalendarBlackoutDatesCollection class.
Top

  NameDescription
Public propertyCountGets the number of elements actually contained in the Collection(Of T). (Inherited from Collection(Of T).)
Public propertyItemGets or sets the element at the specified index. (Inherited from Collection(Of T).)
Protected propertyItemsGets a IList(Of T) wrapper around the Collection(Of T). (Inherited from Collection(Of T).)
Top

  NameDescription
Public methodAddAdds an object to the end of the Collection(Of T). (Inherited from Collection(Of T).)
Public methodAddDatesInPastAdds all dates before Today to the collection.
Protected methodBlockReentrancyDisallows reentrant attempts to change this collection. (Inherited from ObservableCollection(Of T).)
Protected methodCheckReentrancyChecks for reentrant attempts to change this collection. (Inherited from ObservableCollection(Of T).)
Public methodClearRemoves all elements from the Collection(Of T). (Inherited from Collection(Of T).)
Protected methodClearItemsRemoves all items from the collection. (Inherited from ObservableCollection(Of T).)
Public methodContains(T)Determines whether an element is in the Collection(Of T). (Inherited from Collection(Of T).)
Public methodContains(DateTime)Returns a value that represents whether this collection contains the specified date.
Public methodContains(DateTime, DateTime)Returns a value that represents whether this collection contains the specified range of dates.
Public methodContainsAnyReturns a value that represents whether this collection contains any dates in the specified range of dates.
Public methodCopyToCopies the entire Collection(Of T) to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection(Of T).)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorReturns an enumerator that iterates through the Collection(Of T). (Inherited from Collection(Of T).)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfSearches for the specified object and returns the zero-based index of the first occurrence within the entire Collection(Of T). (Inherited from Collection(Of T).)
Public methodInsertInserts an element into the Collection(Of T) at the specified index. (Inherited from Collection(Of T).)
Protected methodInsertItemInserts an item into the collection at the specified index. (Inherited from ObservableCollection(Of T).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMoveMoves the item at the specified index to a new location in the collection. (Inherited from ObservableCollection(Of T).)
Protected methodMoveItemMoves the item at the specified index to a new location in the collection. (Inherited from ObservableCollection(Of T).)
Protected methodOnCollectionChangedRaises the CollectionChanged event with the provided arguments. (Inherited from ObservableCollection(Of T).)
Protected methodOnPropertyChangedRaises the PropertyChanged event with the provided arguments. (Inherited from ObservableCollection(Of T).)
Public methodRemoveRemoves the first occurrence of a specific object from the Collection(Of T). (Inherited from Collection(Of T).)
Public methodRemoveAtRemoves the element at the specified index of the Collection(Of T). (Inherited from Collection(Of T).)
Protected methodRemoveItemRemoves the item at the specified index of the collection. (Inherited from ObservableCollection(Of T).)
Protected methodSetItemReplaces the element at the specified index. (Inherited from ObservableCollection(Of T).)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventCollectionChangedOccurs when an item is added, removed, changed, moved, or the entire list is refreshed. (Inherited from ObservableCollection(Of T).)
Protected eventPropertyChangedOccurs when a property value changes. (Inherited from ObservableCollection(Of T).)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToCopies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from Collection(Of T).)
Explicit interface implemetationPrivate propertyICollection(Of T).IsReadOnlyGets a value indicating whether the ICollection(Of T) is read-only. (Inherited from Collection(Of T).)
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedGets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from Collection(Of T).)
Explicit interface implemetationPrivate propertyICollection.SyncRootGets an object that can be used to synchronize access to the ICollection. (Inherited from Collection(Of T).)
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorReturns an enumerator that iterates through a collection. (Inherited from Collection(Of T).)
Explicit interface implemetationPrivate methodIList.AddAdds an item to the IList. (Inherited from Collection(Of T).)
Explicit interface implemetationPrivate methodIList.ContainsDetermines whether the IList contains a specific value. (Inherited from Collection(Of T).)
Explicit interface implemetationPrivate methodIList.IndexOfDetermines the index of a specific item in the IList. (Inherited from Collection(Of T).)
Explicit interface implemetationPrivate methodIList.InsertInserts an item into the IList at the specified index. (Inherited from Collection(Of T).)
Explicit interface implemetationPrivate propertyIList.IsFixedSizeGets a value indicating whether the IList has a fixed size. (Inherited from Collection(Of T).)
Explicit interface implemetationPrivate propertyIList.IsReadOnlyGets a value indicating whether the IList is read-only. (Inherited from Collection(Of T).)
Explicit interface implemetationPrivate propertyIList.ItemGets or sets the element at the specified index. (Inherited from Collection(Of T).)
Explicit interface implemetationPrivate methodIList.RemoveRemoves the first occurrence of a specific object from the IList. (Inherited from Collection(Of T).)
Explicit interface implemetationPrivate eventINotifyPropertyChanged.PropertyChangedOccurs when a property value changes. (Inherited from ObservableCollection(Of 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.


' 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

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.

Community Additions

ADD
Show:
© 2014 Microsoft