-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
CalendarBlackoutDatesCollection.xml
360 lines (340 loc) · 20.6 KB
/
CalendarBlackoutDatesCollection.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
<Type Name="CalendarBlackoutDatesCollection" FullName="System.Windows.Controls.CalendarBlackoutDatesCollection">
<TypeSignature Language="C#" Value="public sealed class CalendarBlackoutDatesCollection : System.Collections.ObjectModel.ObservableCollection<System.Windows.Controls.CalendarDateRange>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit CalendarBlackoutDatesCollection extends System.Collections.ObjectModel.ObservableCollection`1<class System.Windows.Controls.CalendarDateRange>" />
<TypeSignature Language="DocId" Value="T:System.Windows.Controls.CalendarBlackoutDatesCollection" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class CalendarBlackoutDatesCollection
Inherits ObservableCollection(Of CalendarDateRange)" />
<TypeSignature Language="F#" Value="type CalendarBlackoutDatesCollection = class
 inherit ObservableCollection<CalendarDateRange>" />
<TypeSignature Language="C++ CLI" Value="public ref class CalendarBlackoutDatesCollection sealed : System::Collections::ObjectModel::ObservableCollection<System::Windows::Controls::CalendarDateRange ^>" />
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Collections.ObjectModel.ObservableCollection<System.Windows.Controls.CalendarDateRange></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="!0">System.Windows.Controls.CalendarDateRange</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Docs>
<summary>Represents a collection of non-selectable dates in a <see cref="T:System.Windows.Controls.Calendar" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Windows.Controls.CalendarBlackoutDatesCollection> contains <xref:System.Windows.Controls.CalendarDateRange> objects that specify multiple dates that cannot be selected by a user. To make all past dates not selectable, you can use the <xref:System.Windows.Controls.CalendarBlackoutDatesCollection.AddDatesInPast%2A> method.
<a name="xamlPropertyElementUsage_CalendarBlackoutDatesCollection"></a>
## XAML Property Element Usage
```
<object>
<object.property>
oneOrMoreCalendarDateRanges
</object.property>
</object>
```
<a name="xamlValues_CalendarBlackoutDatesCollection"></a>
## XAML Values
*oneOrMoreCalendarDateRanges*
One or more object elements of type <xref:System.Windows.Controls.CalendarDateRange>.
## Examples
The following example creates a <xref:System.Windows.Controls.Calendar> in code and markup that has some dates that cannot be selected.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Calendar/Overview/window1.xaml.cs" id="Snippet3":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/calendarsnippets/visualbasic/window1.xaml.vb" id="Snippet3":::
:::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/calendarsnippets/xaml/window1.xaml" id="Snippet3":::
The preceding example produces output that is similar to the following illustration.
![Calendar with dates that cannot be selected.](~/add/media/ndp-calendarblackout.png "Calendar with dates that cannot be selected.")
Calendar with dates that cannot be selected
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CalendarBlackoutDatesCollection (System.Windows.Controls.Calendar owner);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Windows.Controls.Calendar owner) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Controls.CalendarBlackoutDatesCollection.#ctor(System.Windows.Controls.Calendar)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (owner As Calendar)" />
<MemberSignature Language="F#" Value="new System.Windows.Controls.CalendarBlackoutDatesCollection : System.Windows.Controls.Calendar -> System.Windows.Controls.CalendarBlackoutDatesCollection" Usage="new System.Windows.Controls.CalendarBlackoutDatesCollection owner" />
<MemberSignature Language="C++ CLI" Value="public:
 CalendarBlackoutDatesCollection(System::Windows::Controls::Calendar ^ owner);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="owner" Type="System.Windows.Controls.Calendar" />
</Parameters>
<Docs>
<param name="owner">The <see cref="T:System.Windows.Controls.Calendar" /> whose dates this object represents.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Controls.CalendarBlackoutDatesCollection" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddDatesInPast">
<MemberSignature Language="C#" Value="public void AddDatesInPast ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddDatesInPast() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Controls.CalendarBlackoutDatesCollection.AddDatesInPast" />
<MemberSignature Language="VB.NET" Value="Public Sub AddDatesInPast ()" />
<MemberSignature Language="F#" Value="member this.AddDatesInPast : unit -> unit" Usage="calendarBlackoutDatesCollection.AddDatesInPast " />
<MemberSignature Language="C++ CLI" Value="public:
 void AddDatesInPast();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Adds all dates before <see cref="P:System.DateTime.Today" /> to the collection.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method to prevent users from selecting dates that are in the past.
## Examples
The following example creates a <xref:System.Windows.Controls.Calendar> that includes a <xref:System.Windows.FrameworkElement.Loaded> event handler.
:::code language="xaml" source="~/snippets/xaml/VS_Snippets_Wpf/calendarsnippets/xaml/window1.xaml" id="Snippet6":::
The following example shows the <xref:System.Windows.FrameworkElement.Loaded> event handler. The event handler calls the <xref:System.Windows.Controls.CalendarBlackoutDatesCollection.AddDatesInPast%2A> method to make only future dates selectable.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Controls/Calendar/Overview/window1.xaml.cs" id="Snippet7":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/calendarsnippets/visualbasic/window1.xaml.vb" id="Snippet7":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ClearItems">
<MemberSignature Language="C#" Value="protected override void ClearItems ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void ClearItems() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Controls.CalendarBlackoutDatesCollection.ClearItems" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub ClearItems ()" />
<MemberSignature Language="F#" Value="override this.ClearItems : unit -> unit" Usage="calendarBlackoutDatesCollection.ClearItems " />
<MemberSignature Language="C++ CLI" Value="protected:
 override void ClearItems();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="Contains">
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Returns a value that represents whether this collection contains the specified date or dates.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Contains">
<MemberSignature Language="C#" Value="public bool Contains (DateTime date);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Contains(valuetype System.DateTime date) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Controls.CalendarBlackoutDatesCollection.Contains(System.DateTime)" />
<MemberSignature Language="VB.NET" Value="Public Function Contains (date As DateTime) As Boolean" />
<MemberSignature Language="F#" Value="override this.Contains : DateTime -> bool" Usage="calendarBlackoutDatesCollection.Contains date" />
<MemberSignature Language="C++ CLI" Value="public:
 bool Contains(DateTime date);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="date" Type="System.DateTime" />
</Parameters>
<Docs>
<param name="date">The date to search for.</param>
<summary>Returns a value that represents whether this collection contains the specified date.</summary>
<returns>
<see langword="true" /> if the collection contains the specified date; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Contains">
<MemberSignature Language="C#" Value="public bool Contains (DateTime start, DateTime end);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Contains(valuetype System.DateTime start, valuetype System.DateTime end) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Controls.CalendarBlackoutDatesCollection.Contains(System.DateTime,System.DateTime)" />
<MemberSignature Language="VB.NET" Value="Public Function Contains (start As DateTime, end As DateTime) As Boolean" />
<MemberSignature Language="F#" Value="override this.Contains : DateTime * DateTime -> bool" Usage="calendarBlackoutDatesCollection.Contains (start, end)" />
<MemberSignature Language="C++ CLI" Value="public:
 bool Contains(DateTime start, DateTime end);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="start" Type="System.DateTime" />
<Parameter Name="end" Type="System.DateTime" />
</Parameters>
<Docs>
<param name="start">The start of the date range.</param>
<param name="end">The end of the date range.</param>
<summary>Returns a value that represents whether this collection contains the specified range of dates.</summary>
<returns>
<see langword="true" /> if all dates in the range are contained in the collection; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContainsAny">
<MemberSignature Language="C#" Value="public bool ContainsAny (System.Windows.Controls.CalendarDateRange range);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool ContainsAny(class System.Windows.Controls.CalendarDateRange range) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Controls.CalendarBlackoutDatesCollection.ContainsAny(System.Windows.Controls.CalendarDateRange)" />
<MemberSignature Language="VB.NET" Value="Public Function ContainsAny (range As CalendarDateRange) As Boolean" />
<MemberSignature Language="F#" Value="member this.ContainsAny : System.Windows.Controls.CalendarDateRange -> bool" Usage="calendarBlackoutDatesCollection.ContainsAny range" />
<MemberSignature Language="C++ CLI" Value="public:
 bool ContainsAny(System::Windows::Controls::CalendarDateRange ^ range);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="range" Type="System.Windows.Controls.CalendarDateRange" />
</Parameters>
<Docs>
<param name="range">The range of dates to search for.</param>
<summary>Returns a value that represents whether this collection contains any dates in the specified range of dates.</summary>
<returns>
<see langword="true" /> if any dates in the range are contained in the collection; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InsertItem">
<MemberSignature Language="C#" Value="protected override void InsertItem (int index, System.Windows.Controls.CalendarDateRange item);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void InsertItem(int32 index, class System.Windows.Controls.CalendarDateRange item) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Controls.CalendarBlackoutDatesCollection.InsertItem(System.Int32,System.Windows.Controls.CalendarDateRange)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub InsertItem (index As Integer, item As CalendarDateRange)" />
<MemberSignature Language="F#" Value="override this.InsertItem : int * System.Windows.Controls.CalendarDateRange -> unit" Usage="calendarBlackoutDatesCollection.InsertItem (index, item)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void InsertItem(int index, System::Windows::Controls::CalendarDateRange ^ item);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="item" Type="System.Windows.Controls.CalendarDateRange" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<param name="item">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveItem">
<MemberSignature Language="C#" Value="protected override void RemoveItem (int index);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void RemoveItem(int32 index) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Controls.CalendarBlackoutDatesCollection.RemoveItem(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub RemoveItem (index As Integer)" />
<MemberSignature Language="F#" Value="override this.RemoveItem : int -> unit" Usage="calendarBlackoutDatesCollection.RemoveItem index" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void RemoveItem(int index);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetItem">
<MemberSignature Language="C#" Value="protected override void SetItem (int index, System.Windows.Controls.CalendarDateRange item);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void SetItem(int32 index, class System.Windows.Controls.CalendarDateRange item) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Controls.CalendarBlackoutDatesCollection.SetItem(System.Int32,System.Windows.Controls.CalendarDateRange)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub SetItem (index As Integer, item As CalendarDateRange)" />
<MemberSignature Language="F#" Value="override this.SetItem : int * System.Windows.Controls.CalendarDateRange -> unit" Usage="calendarBlackoutDatesCollection.SetItem (index, item)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void SetItem(int index, System::Windows::Controls::CalendarDateRange ^ item);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationFramework</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="item" Type="System.Windows.Controls.CalendarDateRange" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<param name="item">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>