Mercurial > silverbladetech

comparison MetroWpf/Libs/Ookii.Dialogs.1.0/lib/net35/Ookii.Dialogs.Wpf.xml @ 15:060f02cd4591

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial commit, pre airport work
author stevenh7776 stevenhollidge@hotmail.com
date Mon, 12 Mar 2012 23:05:21 +0800
parents
children
comparison
equal deleted inserted replaced
14:741981715d94 15:060f02cd4591
1 <?xml version="1.0"?>
2 <doc>
3 <assembly>
4 <name>Ookii.Dialogs.Wpf</name>
5 </assembly>
6 <members>
7 <member name="T:Ookii.Dialogs.Wpf.TaskDialogItemCollection`1">
8 <summary>
9 Represents a list of <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> objects.
10 </summary>
11 <typeparam name="T">The type of the task dialog item.</typeparam>
12 <threadsafety instance="false" static="true"/>
13 </member>
14 <member name="M:Ookii.Dialogs.Wpf.TaskDialogItemCollection`1.ClearItems">
15 <summary>
16 Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.ClearItems"/> method.
17 </summary>
18 </member>
19 <member name="M:Ookii.Dialogs.Wpf.TaskDialogItemCollection`1.InsertItem(System.Int32,`0)">
20 <summary>
21 Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.InsertItem(System.Int32,`0)"/> method.
22 </summary>
23 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
24 <param name="item">The object to insert. May not be <see langword="null"/>.</param>
25 <exception cref="T:System.ArgumentNullException"><paramref name="item"/> is <see langword="null"/>.</exception>
26 <exception cref="T:System.ArgumentException">The <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> specified in <paramref name="item"/> is already associated with a different task dialog.</exception>
27 <exception cref="T:System.InvalidOperationException">The <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> specified in <paramref name="item"/> has a duplicate id or button type.</exception>
28 <exception cref="T:System.ArgumentOutOfRangeException">
29 <para>
30 <paramref name="index"/> is less than zero.
31 </para>
32 <para>
33 -or-
34 </para>
35 <para>
36 <paramref name="index"/> is equal to or greater than <see cref="P:System.Collections.ObjectModel.Collection`1.Count"/>.
37 </para>
38 </exception>
39 </member>
40 <member name="M:Ookii.Dialogs.Wpf.TaskDialogItemCollection`1.RemoveItem(System.Int32)">
41 <summary>
42 Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.RemoveItem(System.Int32)"/> method.
43 </summary>
44 <param name="index">The zero-based index of the element to remove.</param>
45 <exception cref="T:System.ArgumentOutOfRangeException">
46 <para>
47 <paramref name="index"/> is less than zero.
48 </para>
49 <para>
50 -or-
51 </para>
52 <para>
53 <paramref name="index"/> is equal to or greater than <see cref="P:System.Collections.ObjectModel.Collection`1.Count"/>.
54 </para>
55 </exception>
56 </member>
57 <member name="M:Ookii.Dialogs.Wpf.TaskDialogItemCollection`1.SetItem(System.Int32,`0)">
58 <summary>
59 Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.SetItem(System.Int32,`0)"/> method.
60 </summary>
61 <param name="index">The zero-based index of the element to replace.</param>
62 <param name="item">The new value for the element at the specified index. May not be <see langword="null"/>.</param>
63 <exception cref="T:System.ArgumentNullException"><paramref name="item"/> is <see langword="null"/>.</exception>
64 <exception cref="T:System.ArgumentException">The <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> specified in <paramref name="item"/> is already associated with a different task dialog.</exception>
65 <exception cref="T:System.InvalidOperationException">The <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> specified in <paramref name="item"/> has a duplicate id or button type.</exception>
66 <exception cref="T:System.ArgumentOutOfRangeException">
67 <para>
68 <paramref name="index"/> is less than zero.
69 </para>
70 <para>
71 -or-
72 </para>
73 <para>
74 <paramref name="index"/> is equal to or greater than <see cref="P:System.Collections.ObjectModel.Collection`1.Count"/>.
75 </para>
76 </exception>
77 </member>
78 <member name="T:Ookii.Dialogs.Wpf.Properties.Resources">
79 <summary>
80 A strongly-typed resource class, for looking up localized strings, etc.
81 </summary>
82 </member>
83 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.ResourceManager">
84 <summary>
85 Returns the cached ResourceManager instance used by this class.
86 </summary>
87 </member>
88 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.Culture">
89 <summary>
90 Overrides the current thread's CurrentUICulture property for all
91 resource lookups using this strongly typed resource class.
92 </summary>
93 </member>
94 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.AnimationLoadErrorFormat">
95 <summary>
96 Looks up a localized string similar to Unable to load the progress dialog animation: {0}.
97 </summary>
98 </member>
99 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.CredentialEmptyTargetError">
100 <summary>
101 Looks up a localized string similar to The credential target may not be an empty string..
102 </summary>
103 </member>
104 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.CredentialError">
105 <summary>
106 Looks up a localized string similar to An error occurred acquiring credentials..
107 </summary>
108 </member>
109 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.CredentialPromptNotCalled">
110 <summary>
111 Looks up a localized string similar to PromptForCredentialsWithSave has not been called or the credentials were modified after the call..
112 </summary>
113 </member>
114 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.DuplicateButtonTypeError">
115 <summary>
116 Looks up a localized string similar to The task dialog already has a non-custom button with the same type..
117 </summary>
118 </member>
119 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.DuplicateItemIdError">
120 <summary>
121 Looks up a localized string similar to The task dialog already has an item with the same id..
122 </summary>
123 </member>
124 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.FileNotFoundFormat">
125 <summary>
126 Looks up a localized string similar to The file &quot;{0}&quot; could not be found..
127 </summary>
128 </member>
129 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.FolderBrowserDialogNoRootFolder">
130 <summary>
131 Looks up a localized string similar to Unable to retrieve the root folder..
132 </summary>
133 </member>
134 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.GlassNotSupportedError">
135 <summary>
136 Looks up a localized string similar to The current operating system does not support glass, or the Desktop Window Manager is not enabled..
137 </summary>
138 </member>
139 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.InvalidFilterString">
140 <summary>
141 Looks up a localized string similar to Invalid filter string,.
142 </summary>
143 </member>
144 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.InvalidTaskDialogItemIdError">
145 <summary>
146 Looks up a localized string similar to The id of a task dialog item must be higher than 0..
147 </summary>
148 </member>
149 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.NoAssociatedTaskDialogError">
150 <summary>
151 Looks up a localized string similar to The item is not associated with a task dialog..
152 </summary>
153 </member>
154 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.NonCustomTaskDialogButtonIdError">
155 <summary>
156 Looks up a localized string similar to Cannot change the id for a standard button..
157 </summary>
158 </member>
159 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.Preview">
160 <summary>
161 Looks up a localized string similar to Preview.
162 </summary>
163 </member>
164 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.ProgressDialogNotRunningError">
165 <summary>
166 Looks up a localized string similar to The progress dialog is not shown..
167 </summary>
168 </member>
169 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.ProgressDialogRunning">
170 <summary>
171 Looks up a localized string similar to The progress dialog is already running..
172 </summary>
173 </member>
174 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.TaskDialogEmptyButtonLabelError">
175 <summary>
176 Looks up a localized string similar to A custom button or radio button cannot have an empty label..
177 </summary>
178 </member>
179 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.TaskDialogIllegalCrossThreadCallError">
180 <summary>
181 Looks up a localized string similar to Cross-thread operation not valid: Task dialog accessed from a thread other than the thread it was created on while it is visible..
182 </summary>
183 </member>
184 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.TaskDialogItemHasOwnerError">
185 <summary>
186 Looks up a localized string similar to The task dialog item already belongs to another task dialog..
187 </summary>
188 </member>
189 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.TaskDialogNoButtonsError">
190 <summary>
191 Looks up a localized string similar to The task dialog must have buttons..
192 </summary>
193 </member>
194 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.TaskDialogNotRunningError">
195 <summary>
196 Looks up a localized string similar to The task dialog is not current displayed..
197 </summary>
198 </member>
199 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.TaskDialogRunningError">
200 <summary>
201 Looks up a localized string similar to The task dialog is already being displayed..
202 </summary>
203 </member>
204 <member name="P:Ookii.Dialogs.Wpf.Properties.Resources.TaskDialogsNotSupportedError">
205 <summary>
206 Looks up a localized string similar to The operating system does not support task dialogs..
207 </summary>
208 </member>
209 <member name="T:Ookii.Dialogs.Wpf.Interop.IMalloc">
210 <summary>
211 C# definition of the IMalloc interface.
212 </summary>
213 </member>
214 <member name="M:Ookii.Dialogs.Wpf.Interop.IMalloc.Alloc(System.UInt32)">
215 <summary>
216 Allocate a block of memory
217 </summary>
218 <param name="cb">Size, in bytes, of the memory block to be allocated.</param>
219 <returns>a pointer to the allocated memory block.</returns>
220 </member>
221 <member name="M:Ookii.Dialogs.Wpf.Interop.IMalloc.Realloc(System.IntPtr,System.UInt32)">
222 <summary>
223 Changes the size of a previously allocated memory block.
224 </summary>
225 <param name="pv">Pointer to the memory block to be reallocated</param>
226 <param name="cb">Size of the memory block, in bytes, to be reallocated.</param>
227 <returns>reallocated memory block</returns>
228 </member>
229 <member name="M:Ookii.Dialogs.Wpf.Interop.IMalloc.Free(System.IntPtr)">
230 <summary>
231 Free a previously allocated block of memory.
232 </summary>
233 <param name="pv">Pointer to the memory block to be freed.</param>
234 </member>
235 <member name="M:Ookii.Dialogs.Wpf.Interop.IMalloc.GetSize(System.IntPtr)">
236 <summary>
237 This method returns the size, in bytes, of a memory block previously allocated with IMalloc::Alloc or IMalloc::Realloc.
238 </summary>
239 <param name="pv">Pointer to the memory block for which the size is requested</param>
240 <returns>The size of the allocated memory block in bytes.</returns>
241 </member>
242 <member name="M:Ookii.Dialogs.Wpf.Interop.IMalloc.DidAlloc(System.IntPtr)">
243 <summary>
244 This method determines whether this allocator was used to allocate the specified block of memory.
245 </summary>
246 <param name="pv">Pointer to the memory block</param>
247 <returns>
248 1 - allocated
249 0 - not allocated by this IMalloc Instance.
250 -1 if DidAlloc is unable to determine whether or not it allocated the memory block.
251 </returns>
252 </member>
253 <member name="M:Ookii.Dialogs.Wpf.Interop.IMalloc.HeapMinimize">
254 <summary>
255 Minimizes the heap by releasing unused memory to the operating system.
256 </summary>
257 </member>
258 <member name="T:Ookii.Dialogs.Wpf.ProgressBarStyle">
259 <summary>
260 Indicates the type of progress on a task dialog.
261 </summary>
262 </member>
263 <member name="F:Ookii.Dialogs.Wpf.ProgressBarStyle.None">
264 <summary>
265 No progress bar is displayed on the dialog.
266 </summary>
267 </member>
268 <member name="F:Ookii.Dialogs.Wpf.ProgressBarStyle.ProgressBar">
269 <summary>
270 A regular progress bar is displayed on the dialog.
271 </summary>
272 </member>
273 <member name="F:Ookii.Dialogs.Wpf.ProgressBarStyle.MarqueeProgressBar">
274 <summary>
275 A marquee progress bar is displayed on the dialog. Use this value for operations
276 that cannot report concrete progress information.
277 </summary>
278 </member>
279 <member name="T:Ookii.Dialogs.Wpf.CredentialException">
280 <summary>
281 The exception that is thrown when an error occurs getting credentials.
282 </summary>
283 <threadsafety instance="false" static="true" />
284 </member>
285 <member name="M:Ookii.Dialogs.Wpf.CredentialException.#ctor">
286 <summary>
287 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialException"/> class.
288 </summary>
289 </member>
290 <member name="M:Ookii.Dialogs.Wpf.CredentialException.#ctor(System.Int32)">
291 <summary>
292 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialException"/> class with the specified error.
293 </summary>
294 <param name="error">The Win32 error code associated with this exception.</param>
295 </member>
296 <member name="M:Ookii.Dialogs.Wpf.CredentialException.#ctor(System.String)">
297 <summary>
298 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialException"/> class with a specified error message.
299 </summary>
300 <param name="message">The message that describes the error.</param>
301 </member>
302 <member name="M:Ookii.Dialogs.Wpf.CredentialException.#ctor(System.Int32,System.String)">
303 <summary>
304 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialException"/> class with the specified error and the specified detailed description.
305 </summary>
306 <param name="error">The Win32 error code associated with this exception.</param>
307 <param name="message">A detailed description of the error.</param>
308 </member>
309 <member name="M:Ookii.Dialogs.Wpf.CredentialException.#ctor(System.String,System.Exception)">
310 <summary>
311 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
312 </summary>
313 <param name="message">The error message that explains the reason for the exception.</param>
314 <param name="innerException">A reference to the inner exception that is the cause of the current exception.</param>
315 </member>
316 <member name="M:Ookii.Dialogs.Wpf.CredentialException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
317 <summary>
318 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialException"/> class with serialized data.
319 </summary>
320 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
321 <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
322 </member>
323 <member name="T:Ookii.Dialogs.Wpf.VistaOpenFileDialog">
324 <summary>
325 Prompts the user to open a file.
326 </summary>
327 <remarks>
328 <para>
329 Windows Vista provides a new style of common file dialog, with several new features (both from
330 the user's and the programmers perspective).
331 </para>
332 <para>
333 This class will use the Vista-style file dialogs if possible, and automatically fall back to the old-style
334 dialog on versions of Windows older than Vista. This class is aimed at applications that
335 target both Windows Vista and older versions of Windows, and therefore does not provide any
336 of the new APIs provided by Vista's file dialogs.
337 </para>
338 <para>
339 This class precisely duplicates the public interface of <see cref="T:Microsoft.Win32.OpenFileDialog"/> so you can just replace
340 any instances of <see cref="T:Microsoft.Win32.OpenFileDialog"/> with the <see cref="T:Ookii.Dialogs.Wpf.VistaOpenFileDialog"/> without any further changes
341 to your code.
342 </para>
343 </remarks>
344 <threadsafety instance="false" static="true"/>
345 </member>
346 <member name="T:Ookii.Dialogs.Wpf.VistaFileDialog">
347 <summary>
348 Displays a dialog box from which the user can select a file.
349 </summary>
350 <remarks>
351 <para>
352 Windows Vista provides a new style of common file dialog, with several new features (both from
353 the user's and the programmers perspective).
354 </para>
355 <para>
356 This class and derived classes will use the Vista-style file dialogs if possible, and automatically fall back to the old-style
357 dialog on versions of Windows older than Vista. This class is aimed at applications that
358 target both Windows Vista and older versions of Windows, and therefore does not provide any
359 of the new APIs provided by Vista's file dialogs.
360 </para>
361 <para>
362 This class precisely duplicates the public interface of <see cref="T:Microsoft.Win32.FileDialog"/> so you can just replace
363 any instances of <see cref="T:Microsoft.Win32.FileDialog"/> with the <see cref="T:Ookii.Dialogs.Wpf.VistaFileDialog"/> without any further changes
364 to your code.
365 </para>
366 </remarks>
367 <threadsafety instance="false" static="true"/>
368 </member>
369 <member name="M:Ookii.Dialogs.Wpf.VistaFileDialog.#ctor">
370 <summary>
371 Creates a new instance of <see cref="T:Ookii.Dialogs.Wpf.VistaFileDialog"/> class.
372 </summary>
373 </member>
374 <member name="M:Ookii.Dialogs.Wpf.VistaFileDialog.Reset">
375 <summary>
376 Resets all properties to their default values.
377 </summary>
378 </member>
379 <member name="M:Ookii.Dialogs.Wpf.VistaFileDialog.ShowDialog">
380 <summary>
381 Displays the file dialog.
382 </summary>
383 <returns>If the user clicks the OK button of the dialog that is displayed (e.g. <see cref="T:Ookii.Dialogs.Wpf.VistaOpenFileDialog"/>, <see cref="T:Ookii.Dialogs.Wpf.VistaSaveFileDialog"/>), <see langword="true"/> is returned; otherwise, <see langword="false"/>.</returns>
384 </member>
385 <member name="M:Ookii.Dialogs.Wpf.VistaFileDialog.ShowDialog(System.Windows.Window)">
386 <summary>
387 Displays the file dialog.
388 </summary>
389 <param name="owner">Handle to the window that owns the dialog.</param>
390 <returns>If the user clicks the OK button of the dialog that is displayed (e.g. <see cref="T:Ookii.Dialogs.Wpf.VistaOpenFileDialog"/>, <see cref="T:Ookii.Dialogs.Wpf.VistaSaveFileDialog"/>), <see langword="true"/> is returned; otherwise, <see langword="false"/>.</returns>
391 </member>
392 <member name="M:Ookii.Dialogs.Wpf.VistaFileDialog.OnFileOk(System.ComponentModel.CancelEventArgs)">
393 <summary>
394 Raises the <see cref="E:Ookii.Dialogs.Wpf.VistaFileDialog.FileOk"/> event.
395 </summary>
396 <param name="e">A <see cref="T:System.ComponentModel.CancelEventArgs"/> that contains the event data.</param>
397 </member>
398 <member name="E:Ookii.Dialogs.Wpf.VistaFileDialog.FileOk">
399 <summary>
400 Event raised when the user clicks on the Open or Save button on a file dialog box.
401 </summary>
402 </member>
403 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.IsVistaFileDialogSupported">
404 <summary>
405 Gets a value that indicates whether the current OS supports Vista-style common file dialogs.
406 </summary>
407 <value>
408 <see langword="true"/> if Vista-style common file dialgs are supported; otherwise, <see langword="false"/>.
409 </value>
410 <remarks>
411 <para>
412 Returns <see langword="true"/> on Windows Vista or newer operating systems.
413 </para>
414 <para>
415 If this property returns <see langword="false"/>, the <see cref="T:Ookii.Dialogs.Wpf.VistaFileDialog"/> class (and
416 its derived classes) will fall back to the regular file dialog.
417 </para>
418 </remarks>
419 </member>
420 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.AddExtension">
421 <summary>
422 Gets or sets a value indicating whether the dialog box automatically adds an extension to a file name
423 if the user omits the extension.
424 </summary>
425 <value>
426 <see langword="true" /> if the dialog box adds an extension to a file name if the user omits the extension; otherwise, <see langword="false" />.
427 The default value is <see langword="true" />.
428 </value>
429 </member>
430 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.CheckFileExists">
431 <summary>
432 Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.
433 </summary>
434 <value>
435 <see langword="true" /> if the dialog box displays a warning if the user specifies a file name that does not exist;
436 otherwise, <see langword="false" />. The default value is <see langword="false" />.
437 </value>
438 </member>
439 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.CheckPathExists">
440 <summary>
441 Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a path that does not exist.
442 </summary>
443 <value>
444 <see langword="true" /> if the dialog box displays a warning when the user specifies a path that does not exist; otherwise, <see langword="false" />.
445 The default value is <see langword="true" />.
446 </value>
447 </member>
448 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.DefaultExt">
449 <summary>
450 Gets or sets the default file name extension.
451 </summary>
452 <value>
453 The default file name extension. The returned string does not include the period. The default value is an empty string ("").
454 </value>
455 </member>
456 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.DereferenceLinks">
457 <summary>
458 Gets or sets a value indicating whether the dialog box returns the location of the file referenced by the shortcut
459 or whether it returns the location of the shortcut (.lnk).
460 </summary>
461 <value>
462 <see langword="true" /> if the dialog box returns the location of the file referenced by the shortcut; otherwise, <see langword="false" />.
463 The default value is <see langword="true" />.
464 </value>
465 </member>
466 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.FileName">
467 <summary>
468 Gets or sets a string containing the file name selected in the file dialog box.
469 </summary>
470 <value>
471 The file name selected in the file dialog box. The default value is an empty string ("").
472 </value>
473 </member>
474 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.FileNames">
475 <summary>
476 Gets the file names of all selected files in the dialog box.
477 </summary>
478 <value>
479 An array of type <see cref="T:System.String"/>, containing the file names of all selected files in the dialog box.
480 </value>
481 </member>
482 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.Filter">
483 <summary>
484 Gets or sets the current file name filter string, which determines the choices that appear in the
485 "Save as file type" or "Files of type" box in the dialog box.
486 </summary>
487 <value>
488 The file filtering options available in the dialog box.
489 </value>
490 <exception cref="T:System.ArgumentException">Filter format is invalid.</exception>
491 </member>
492 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.FilterIndex">
493 <summary>
494 Gets or sets the index of the filter currently selected in the file dialog box.
495 </summary>
496 <value>
497 A value containing the index of the filter currently selected in the file dialog box. The default value is 1.
498 </value>
499 </member>
500 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.InitialDirectory">
501 <summary>
502 Gets or sets the initial directory displayed by the file dialog box.
503 </summary>
504 <value>
505 The initial directory displayed by the file dialog box. The default is an empty string ("").
506 </value>
507 </member>
508 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.RestoreDirectory">
509 <summary>
510 Gets or sets a value indicating whether the dialog box restores the current directory before closing.
511 </summary>
512 <value>
513 <see langword="true" /> if the dialog box restores the current directory to its original value if the user changed the
514 directory while searching for files; otherwise, <see langword="false" />. The default value is <see langword="false" />.
515 </value>
516 </member>
517 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.Title">
518 <summary>
519 Gets or sets the file dialog box title.
520 </summary>
521 <value>
522 The file dialog box title. The default value is an empty string ("").
523 </value>
524 </member>
525 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.ValidateNames">
526 <summary>
527 Gets or sets a value indicating whether the dialog box accepts only valid Win32 file names.
528 </summary>
529 <value>
530 <see langword="true" /> if the dialog box accepts only valid Win32 file names; otherwise, <see langword="false" />. The default value is <see langword="false" />.
531 </value>
532 </member>
533 <member name="P:Ookii.Dialogs.Wpf.VistaFileDialog.DownlevelDialog">
534 <summary>
535 Gets or sets the downlevel file dialog which is to be used if the Vista-style
536 dialog is not supported.
537 </summary>
538 <value>
539 The regular <see cref="T:Microsoft.Win32.FileDialog"/> that is used when the Vista-style file dialog
540 is not supported.
541 </value>
542 <remarks>
543 This property is set by classes that derive from <see cref="T:Ookii.Dialogs.Wpf.VistaFileDialog"/>.
544 </remarks>
545 </member>
546 <member name="M:Ookii.Dialogs.Wpf.VistaOpenFileDialog.#ctor">
547 <summary>
548 Creates a new instance of <see cref="T:Ookii.Dialogs.Wpf.VistaOpenFileDialog"/> class.
549 </summary>
550 </member>
551 <member name="M:Ookii.Dialogs.Wpf.VistaOpenFileDialog.Reset">
552 <summary>
553 Resets all properties to their default values.
554 </summary>
555 </member>
556 <member name="M:Ookii.Dialogs.Wpf.VistaOpenFileDialog.OpenFile">
557 <summary>
558 Opens the file selected by the user, with read-only permission. The file is specified by the FileName property.
559 </summary>
560 <returns>A Stream that specifies the read-only file selected by the user.</returns>
561 <exception cref="T:System.ArgumentNullException">The file name is <see langword="null"/>.</exception>
562 </member>
563 <member name="P:Ookii.Dialogs.Wpf.VistaOpenFileDialog.CheckFileExists">
564 <summary>
565 Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.
566 </summary>
567 <value>
568 <see langword="true" /> if the dialog box displays a warning if the user specifies a file name that does not exist; otherwise, <see langword="false" />. The default value is <see langword="true" />.
569 </value>
570 </member>
571 <member name="P:Ookii.Dialogs.Wpf.VistaOpenFileDialog.Multiselect">
572 <summary>
573 Gets or sets a value indicating whether the dialog box allows multiple files to be selected.
574 </summary>
575 <value>
576 <see langword="true" /> if the dialog box allows multiple files to be selected together or concurrently; otherwise, <see langword="false" />.
577 The default value is <see langword="false" />.
578 </value>
579 </member>
580 <member name="P:Ookii.Dialogs.Wpf.VistaOpenFileDialog.ShowReadOnly">
581 <summary>
582 Gets or sets a value indicating whether the dialog box contains a read-only check box.
583 </summary>
584 <value>
585 <see langword="true" /> if the dialog box contains a read-only check box; otherwise, <see langword="false" />. The default value is <see langword="false" />.
586 </value>
587 <remarks>
588 If the Vista style dialog is used, this property can only be used to determine whether the user chose
589 Open as read-only on the dialog; setting it in code will have no effect.
590 </remarks>
591 </member>
592 <member name="P:Ookii.Dialogs.Wpf.VistaOpenFileDialog.ReadOnlyChecked">
593 <summary>
594 Gets or sets a value indicating whether the read-only check box is selected.
595 </summary>
596 <value>
597 <see langword="true" /> if the read-only check box is selected; otherwise, <see langword="false" />. The default value is <see langword="false" />.
598 </value>
599 </member>
600 <member name="T:Ookii.Dialogs.Wpf.TaskDialogButton">
601 <summary>
602 A button on a <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/>.
603 </summary>
604 <threadsafety instance="false" static="true"/>
605 </member>
606 <member name="T:Ookii.Dialogs.Wpf.TaskDialogItem">
607 <summary>
608 Represents a button or radio button on a task dialog.
609 </summary>
610 <threadsafety instance="false" static="true" />
611 </member>
612 <member name="F:Ookii.Dialogs.Wpf.TaskDialogItem.components">
613 <summary>
614 Required designer variable.
615 </summary>
616 </member>
617 <member name="M:Ookii.Dialogs.Wpf.TaskDialogItem.Dispose(System.Boolean)">
618 <summary>
619 Clean up any resources being used.
620 </summary>
621 <param name="disposing"><see langword="true"/> if managed resources should be disposed; otherwise, <see langword="false"/>.</param>
622 </member>
623 <member name="M:Ookii.Dialogs.Wpf.TaskDialogItem.InitializeComponent">
624 <summary>
625 Required method for Designer support - do not modify
626 the contents of this method with the code editor.
627 </summary>
628 </member>
629 <member name="M:Ookii.Dialogs.Wpf.TaskDialogItem.#ctor">
630 <summary>
631 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> class.
632 </summary>
633 </member>
634 <member name="M:Ookii.Dialogs.Wpf.TaskDialogItem.#ctor(System.ComponentModel.IContainer)">
635 <summary>
636 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> class with the specified container.
637 </summary>
638 <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> to.</param>
639 </member>
640 <member name="M:Ookii.Dialogs.Wpf.TaskDialogItem.Click">
641 <summary>
642 Simulates a click on the task dialog item.
643 </summary>
644 <remarks>
645 This method is available only while the task dialog is being displayed. You would typically call
646 it from one of the events fired by the <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/> class while the dialog is visible.
647 </remarks>
648 <exception cref="T:System.InvalidOperationException">
649 <para>The task dialog is not being displayed</para>
650 <para>-or-</para>
651 <para>The item has no associated task dialog.</para>
652 </exception>
653 </member>
654 <member name="M:Ookii.Dialogs.Wpf.TaskDialogItem.UpdateOwner">
655 <summary>
656 Causes a full update of the owner dialog.
657 </summary>
658 <remarks>
659 <para>
660 When this method is called, the owner dialog will be updated to reflect the
661 current state of the object.
662 </para>
663 <para>
664 When the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> has no owner, or the owner is not being
665 displayed, this method has no effect.
666 </para>
667 </remarks>
668 </member>
669 <member name="P:Ookii.Dialogs.Wpf.TaskDialogItem.Owner">
670 <summary>
671 Gets the <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/> that owns this <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/>.
672 </summary>
673 <value>
674 The <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/> that owns this <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/>.
675 </value>
676 <remarks>
677 This property is set automatically when the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> is added
678 to the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.Buttons"/> or <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.RadioButtons"/>
679 collection of a <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/>.
680 </remarks>
681 </member>
682 <member name="P:Ookii.Dialogs.Wpf.TaskDialogItem.Text">
683 <summary>
684 Gets or sets the text of the item.
685 </summary>
686 <value>
687 The text of the item. The default value is an empty string ("").
688 </value>
689 <remarks>
690 <para>
691 For buttons, this property is ignored if <see cref="P:Ookii.Dialogs.Wpf.TaskDialogButton.ButtonType"/> is any value other
692 than <see cref="F:Ookii.Dialogs.Wpf.ButtonType.Custom"/>.
693 </para>
694 </remarks>
695 </member>
696 <member name="P:Ookii.Dialogs.Wpf.TaskDialogItem.Enabled">
697 <summary>
698 Gets or sets a value that indicates whether the item is enabled.
699 </summary>
700 <value>
701 <see langword="true" /> if this item is enabled; otherwise, <see langword="false" />.
702 </value>
703 <remarks>
704 If a button or radio button is not enabled, it will be grayed out and cannot be
705 selected or clicked.
706 </remarks>
707 </member>
708 <member name="P:Ookii.Dialogs.Wpf.TaskDialogItem.Id">
709 <summary>
710 Gets or sets the ID of the item.
711 </summary>
712 <value>
713 The unique identifier of the item.
714 </value>
715 <remarks>
716 <para>
717 The identifier of an item must be unique for the type of item on the task dialog (i.e. no two
718 buttons can have the same id, no two radio buttons can have the same id, but a radio button
719 can have the same id as a button).
720 </para>
721 <para>
722 If this property is zero when the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> is added to the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.Buttons"/>
723 or <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.RadioButtons"/> collection of a task dialog, it will automatically be set
724 to the next available id value.
725 </para>
726 </remarks>
727 </member>
728 <member name="P:Ookii.Dialogs.Wpf.TaskDialogItem.ItemCollection">
729 <summary>
730 When implemented in a derived class, gets the item collection on a task dialog that this type of item is
731 part of.
732 </summary>
733 <value>
734 For <see cref="T:Ookii.Dialogs.Wpf.TaskDialogButton"/> items, the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.Buttons"/>
735 collection of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/> instance this item is part of. For <see cref="T:Ookii.Dialogs.Wpf.TaskDialogRadioButton"/> items, the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.RadioButtons"/>
736 collection of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/> instance this item is part of. If the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> is not
737 currently associated with a <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/>, <see langword="null"/>.
738 </value>
739 <remarks>
740 The collection returned by this property is used to determine if there are any items with duplicate IDs.
741 </remarks>
742 </member>
743 <member name="M:Ookii.Dialogs.Wpf.TaskDialogButton.#ctor">
744 <summary>
745 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogButton"/> class.
746 </summary>
747 </member>
748 <member name="M:Ookii.Dialogs.Wpf.TaskDialogButton.#ctor(Ookii.Dialogs.Wpf.ButtonType)">
749 <summary>
750 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogButton"/> class with the specified button type.
751 </summary>
752 <param name="type">The type of the button.</param>
753 </member>
754 <member name="M:Ookii.Dialogs.Wpf.TaskDialogButton.#ctor(System.ComponentModel.IContainer)">
755 <summary>
756 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogButton"/> class with the specified container.
757 </summary>
758 <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogButton"/> to.</param>
759 </member>
760 <member name="M:Ookii.Dialogs.Wpf.TaskDialogButton.#ctor(System.String)">
761 <summary>
762 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogButton"/> class with the specified text.
763 </summary>
764 <param name="text">The text of the button.</param>
765 </member>
766 <member name="P:Ookii.Dialogs.Wpf.TaskDialogButton.ButtonType">
767 <summary>
768 Gets or sets the type of the button.
769 </summary>
770 <value>
771 One of the <see cref="T:Ookii.Dialogs.Wpf.ButtonType"/> values that indicates the type of the button. The default value
772 is <see cref="F:Ookii.Dialogs.Wpf.ButtonType.Custom"/>.
773 </value>
774 </member>
775 <member name="P:Ookii.Dialogs.Wpf.TaskDialogButton.CommandLinkNote">
776 <summary>
777 Gets or sets the text of the note associated with a command link button.
778 </summary>
779 <value>
780 The text of the note associated with a command link button.
781 </value>
782 <remarks>
783 <para>
784 This property applies only to buttons where the <see cref="T:System.Type"/> property
785 is <see cref="F:Ookii.Dialogs.Wpf.ButtonType.Custom"/>. For other button types, it is ignored.
786 </para>
787 <para>
788 In addition, it is used only if the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ButtonStyle"/> property is set to
789 <see cref="F:Ookii.Dialogs.Wpf.TaskDialogButtonStyle.CommandLinks"/> or <see cref="F:Ookii.Dialogs.Wpf.TaskDialogButtonStyle.CommandLinksNoIcon"/>;
790 otherwise, it is ignored.
791 </para>
792 </remarks>
793 </member>
794 <member name="P:Ookii.Dialogs.Wpf.TaskDialogButton.Default">
795 <summary>
796 Gets or sets a value that indicates if the button is the default button on the dialog.
797 </summary>
798 <value><see langword="true" /> if the button is the default button; otherwise, <see langword="false" />.
799 The default value is <see langword="false" />.</value>
800 <remarks>
801 If no button has this property set to <see langword="true" />, the first button on the dialog will be the default button.
802 </remarks>
803 </member>
804 <member name="P:Ookii.Dialogs.Wpf.TaskDialogButton.ElevationRequired">
805 <summary>
806 Gets or sets a value that indicates whether the Task Dialog button or command link should have a
807 User Account Control (UAC) shield icon (in other words, whether the action invoked by the
808 button requires elevation).
809 </summary>
810 <value>
811 <see langword="true" /> if the button contains a UAC shield icon; otherwise, <see langword="false" />.
812 </value>
813 <remarks>
814 Elevation is not performed by the task dialog; the code implementing the operation that results from
815 the button being clicked is responsible for performing elevation if required.
816 </remarks>
817 </member>
818 <member name="P:Ookii.Dialogs.Wpf.TaskDialogButton.ItemCollection">
819 <summary>
820 Gets the collection that items of this type are part of.
821 </summary>
822 <value>
823 If the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogButton"/> is currently associated with a <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/>, the
824 <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.Buttons"/> collection of that <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/>; otherwise, <see langword="null"/>.
825 </value>
826 </member>
827 <member name="T:Ookii.Dialogs.Wpf.TaskDialog">
828 <summary>
829 Displays a Task Dialog.
830 </summary>
831 <remarks>
832 The task dialog contains an application-defined message text and title, icons, and any combination of predefined push buttons.
833 Task Dialogs are supported only on Windows Vista and above. No fallback is provided; if you wish to use task dialogs
834 and support operating systems older than Windows Vista, you must provide a fallback yourself. Check the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.OSSupportsTaskDialogs"/>
835 property to see if task dialogs are supported. It is safe to instantiate the <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/> class on an older
836 OS, but calling <see cref="M:Ookii.Dialogs.Wpf.TaskDialog.Show"/> or <see cref="M:Ookii.Dialogs.Wpf.TaskDialog.ShowDialog"/> will throw an exception.
837 </remarks>
838 <threadsafety static="true" instance="false"/>
839 </member>
840 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.#ctor">
841 <summary>
842 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/> class.
843 </summary>
844 </member>
845 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.#ctor(System.ComponentModel.IContainer)">
846 <summary>
847 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/> class with the specified container.
848 </summary>
849 <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/> to.</param>
850 </member>
851 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.Show">
852 <summary>
853 Shows the task dialog as a modeless dialog.
854 </summary>
855 <returns>The button that the user clicked. Can be <see langword="null"/> if the user cancelled the dialog using the
856 title bar close button.</returns>
857 <remarks>
858 <note>
859 Although the dialog is modeless, this method does not return until the task dialog is closed.
860 </note>
861 </remarks>
862 <exception cref="T:System.InvalidOperationException">
863 <para>
864 One of the properties or a combination of properties is not valid.
865 </para>
866 <para>
867 -or-
868 </para>
869 <para>
870 The dialog is already running.
871 </para>
872 </exception>
873 <exception cref="T:System.NotSupportedException">Task dialogs are not supported on the current operating system.</exception>
874 </member>
875 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.ShowDialog">
876 <summary>
877 Shows the task dialog as a modal dialog.
878 </summary>
879 <returns>The button that the user clicked. Can be <see langword="null"/> if the user cancelled the dialog using the
880 title bar close button.</returns>
881 <remarks>
882 The dialog will use the active window as its owner. If the current process has no active window,
883 the dialog will be displayed as a modeless dialog (identical to calling <see cref="M:Ookii.Dialogs.Wpf.TaskDialog.Show"/>).
884 </remarks>
885 <exception cref="T:System.InvalidOperationException">
886 <para>
887 One of the properties or a combination of properties is not valid.
888 </para>
889 <para>
890 -or-
891 </para>
892 <para>
893 The dialog is already running.
894 </para>
895 </exception>
896 <exception cref="T:System.NotSupportedException">Task dialogs are not supported on the current operating system.</exception>
897 </member>
898 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.ShowDialog(System.Windows.Window)">
899 <summary>
900 Shows the task dialog as a modal dialog.
901 </summary>
902 <param name="owner">The <see cref="T:System.Windows.Window"/> that is the owner of this task dialog.</param>
903 <returns>The button that the user clicked. Can be <see langword="null"/> if the user cancelled the dialog using the
904 title bar close button.</returns>
905 <exception cref="T:System.InvalidOperationException">
906 <para>
907 One of the properties or a combination of properties is not valid.
908 </para>
909 <para>
910 -or-
911 </para>
912 <para>
913 The dialog is already running.
914 </para>
915 </exception>
916 <exception cref="T:System.NotSupportedException">Task dialogs are not supported on the current operating system.</exception>
917 </member>
918 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.ClickVerification(System.Boolean,System.Boolean)">
919 <summary>
920 Simulates a click on the verification checkbox of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/>, if it exists.
921 </summary>
922 <param name="checkState"><see langword="true"/> to set the state of the checkbox to be checked; <see langword="false"/> to set it to be unchecked.</param>
923 <param name="setFocus"><see langword="true"/> to set the keyboard focus to the checkbox; otherwise <see langword="false"/>.</param>
924 <exception cref="T:System.InvalidOperationException">The task dialog is not being displayed.</exception>
925 </member>
926 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.OnHyperlinkClicked(Ookii.Dialogs.Wpf.HyperlinkClickedEventArgs)">
927 <summary>
928 Raises the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.HyperlinkClicked"/> event.
929 </summary>
930 <param name="e">The <see cref="T:Ookii.Dialogs.Wpf.HyperlinkClickedEventArgs"/> containing the data for the event.</param>
931 </member>
932 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.OnButtonClicked(Ookii.Dialogs.Wpf.TaskDialogItemClickedEventArgs)">
933 <summary>
934 Raises the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.ButtonClicked"/> event.
935 </summary>
936 <param name="e">The <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItemClickedEventArgs"/> containing the data for the event.</param>
937 </member>
938 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.OnRadioButtonClicked(Ookii.Dialogs.Wpf.TaskDialogItemClickedEventArgs)">
939 <summary>
940 Raises the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.RadioButtonClicked"/> event.
941 </summary>
942 <param name="e">The <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItemClickedEventArgs"/> containing the data for the event.</param>
943 </member>
944 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.OnVerificationClicked(System.EventArgs)">
945 <summary>
946 Raises the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.VerificationClicked"/> event.
947 </summary>
948 <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>
949 </member>
950 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.OnCreated(System.EventArgs)">
951 <summary>
952 Raises the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.Created"/> event.
953 </summary>
954 <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>
955 </member>
956 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.OnTimer(Ookii.Dialogs.Wpf.TimerEventArgs)">
957 <summary>
958 Raises the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.Timer"/> event.
959 </summary>
960 <param name="e">The <see cref="T:Ookii.Dialogs.Wpf.TimerEventArgs"/> containing the data for the event.</param>
961 </member>
962 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.OnDestroyed(System.EventArgs)">
963 <summary>
964 Raises the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.Destroyed"/> event.
965 </summary>
966 <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>
967 </member>
968 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.OnExpandButtonClicked(Ookii.Dialogs.Wpf.ExpandButtonClickedEventArgs)">
969 <summary>
970 Raises the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.ExpandButtonClicked"/> event.
971 </summary>
972 <param name="e">The <see cref="T:Ookii.Dialogs.Wpf.ExpandButtonClickedEventArgs"/> containing the data for the event.</param>
973 </member>
974 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.OnHelpRequested(System.EventArgs)">
975 <summary>
976 Raises the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.HelpRequested"/> event.
977 </summary>
978 <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>
979 </member>
980 <member name="F:Ookii.Dialogs.Wpf.TaskDialog.components">
981 <summary>
982 Required designer variable.
983 </summary>
984 </member>
985 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.Dispose(System.Boolean)">
986 <summary>
987 Clean up any resources being used.
988 </summary>
989 <param name="disposing"><see langword="true" /> if managed resources should be disposed; otherwise, <see langword="false" />.</param>
990 </member>
991 <member name="M:Ookii.Dialogs.Wpf.TaskDialog.InitializeComponent">
992 <summary>
993 Required method for Designer support - do not modify
994 the contents of this method with the code editor.
995 </summary>
996 </member>
997 <member name="E:Ookii.Dialogs.Wpf.TaskDialog.Created">
998 <summary>
999 Event raised when the task dialog has been created.
1000 </summary>
1001 <remarks>
1002 This event is raised once after calling <see cref="M:Ookii.Dialogs.Wpf.TaskDialog.ShowDialog(System.Windows.Window)"/>, after the dialog
1003 is created and before it is displayed.
1004 </remarks>
1005 </member>
1006 <member name="E:Ookii.Dialogs.Wpf.TaskDialog.Destroyed">
1007 <summary>
1008 Event raised when the task dialog has been destroyed.
1009 </summary>
1010 <remarks>
1011 The task dialog window no longer exists when this event is raised.
1012 </remarks>
1013 </member>
1014 <member name="E:Ookii.Dialogs.Wpf.TaskDialog.ButtonClicked">
1015 <summary>
1016 Event raised when the user clicks a button on the task dialog.
1017 </summary>
1018 <remarks>
1019 Set the <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> property to <see langword="true"/> to prevent the dialog from being closed.
1020 </remarks>
1021 </member>
1022 <member name="E:Ookii.Dialogs.Wpf.TaskDialog.RadioButtonClicked">
1023 <summary>
1024 Event raised when the user clicks a radio button on the task dialog.
1025 </summary>
1026 <remarks>
1027 The <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> property is ignored for this event.
1028 </remarks>
1029 </member>
1030 <member name="E:Ookii.Dialogs.Wpf.TaskDialog.HyperlinkClicked">
1031 <summary>
1032 Event raised when the user clicks a hyperlink.
1033 </summary>
1034 </member>
1035 <member name="E:Ookii.Dialogs.Wpf.TaskDialog.VerificationClicked">
1036 <summary>
1037 Event raised when the user clicks the verification check box.
1038 </summary>
1039 </member>
1040 <member name="E:Ookii.Dialogs.Wpf.TaskDialog.Timer">
1041 <summary>
1042 Event raised periodically while the dialog is displayed.
1043 </summary>
1044 <remarks>
1045 <para>
1046 This event is raised only when the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.RaiseTimerEvent"/> property is set to <see langword="true"/>. The event is
1047 raised approximately every 200 milliseconds.
1048 </para>
1049 <para>
1050 To reset the tick count, set the <see cref="P:Ookii.Dialogs.Wpf.TimerEventArgs.ResetTickCount"/>
1051 property to <see langword="true"/>.
1052 </para>
1053 </remarks>
1054 </member>
1055 <member name="E:Ookii.Dialogs.Wpf.TaskDialog.ExpandButtonClicked">
1056 <summary>
1057 Event raised when the user clicks the expand button on the task dialog.
1058 </summary>
1059 <remarks>
1060 The <see cref="P:Ookii.Dialogs.Wpf.ExpandButtonClickedEventArgs.Expanded"/> property indicates if the expanded information is visible
1061 or not after the click.
1062 </remarks>
1063 </member>
1064 <member name="E:Ookii.Dialogs.Wpf.TaskDialog.HelpRequested">
1065 <summary>
1066 Event raised when the user presses F1 while the dialog has focus.
1067 </summary>
1068 </member>
1069 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.OSSupportsTaskDialogs">
1070 <summary>
1071 Gets a value that indicates whether the current operating system supports task dialogs.
1072 </summary>
1073 <value>
1074 Returns <see langword="true" /> for Windows Vista or later; otherwise <see langword="false" />.
1075 </value>
1076 </member>
1077 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.Buttons">
1078 <summary>
1079 Gets a list of the buttons on the Task Dialog.
1080 </summary>
1081 <value>
1082 A list of the buttons on the Task Dialog.
1083 </value>
1084 <remarks>
1085 Custom buttons are displayed in the order they have in the collection. Standard buttons will always be displayed
1086 in the Windows-defined order, regardless of the order of the buttons in the collection.
1087 </remarks>
1088 </member>
1089 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.RadioButtons">
1090 <summary>
1091 Gets a list of the radio buttons on the Task Dialog.
1092 </summary>
1093 <value>
1094 A list of the radio buttons on the Task Dialog.
1095 </value>
1096 </member>
1097 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.WindowTitle">
1098 <summary>
1099 Gets or sets the window title of the task dialog.
1100 </summary>
1101 <value>
1102 The window title of the task dialog. The default is an empty string ("").
1103 </value>
1104 </member>
1105 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.MainInstruction">
1106 <summary>
1107 Gets or sets the dialog's main instruction.
1108 </summary>
1109 <value>
1110 The dialog's main instruction. The default is an empty string ("").
1111 </value>
1112 <remarks>
1113 The main instruction of a task dialog will be displayed in a larger font and a different color than
1114 the other text of the task dialog.
1115 </remarks>
1116 </member>
1117 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.Content">
1118 <summary>
1119 Gets or sets the dialog's primary content.
1120 </summary>
1121 <value>
1122 The dialog's primary content. The default is an empty string ("").
1123 </value>
1124 </member>
1125 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.WindowIcon">
1126 <summary>
1127 Gets or sets the icon to be used in the title bar of the dialog.
1128 </summary>
1129 <value>
1130 An <see cref="T:System.Drawing.Icon"/> that represents the icon of the task dialog's window.
1131 </value>
1132 <remarks>
1133 This property is used only when the dialog is shown as a modeless dialog; if the dialog
1134 is modal, it will have no icon.
1135 </remarks>
1136 </member>
1137 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.MainIcon">
1138 <summary>
1139 Gets or sets the icon to display in the task dialog.
1140 </summary>
1141 <value>
1142 A <see cref="T:Ookii.Dialogs.Wpf.TaskDialogIcon"/> that indicates the icon to display in the main content area of the task dialog.
1143 The default is <see cref="F:Ookii.Dialogs.Wpf.TaskDialogIcon.Custom"/>.
1144 </value>
1145 <remarks>
1146 When this property is set to <see cref="F:Ookii.Dialogs.Wpf.TaskDialogIcon.Custom"/>, use the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.CustomMainIcon"/> property to
1147 specify the icon to use.
1148 </remarks>
1149 </member>
1150 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.CustomMainIcon">
1151 <summary>
1152 Gets or sets a custom icon to display in the dialog.
1153 </summary>
1154 <value>
1155 An <see cref="T:System.Drawing.Icon"/> that represents the icon to display in the main content area of the task dialog,
1156 or <see langword="null"/> if no custom icon is used. The default value is <see langword="null"/>.
1157 </value>
1158 <remarks>
1159 This property is ignored if the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.MainIcon"/> property has a value other than <see cref="F:Ookii.Dialogs.Wpf.TaskDialogIcon.Custom"/>.
1160 </remarks>
1161 </member>
1162 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.FooterIcon">
1163 <summary>
1164 Gets or sets the icon to display in the footer area of the task dialog.
1165 </summary>
1166 <value>
1167 A <see cref="T:Ookii.Dialogs.Wpf.TaskDialogIcon"/> that indicates the icon to display in the footer area of the task dialog.
1168 The default is <see cref="F:Ookii.Dialogs.Wpf.TaskDialogIcon.Custom"/>.
1169 </value>
1170 <remarks>
1171 <para>
1172 When this property is set to <see cref="F:Ookii.Dialogs.Wpf.TaskDialogIcon.Custom"/>, use the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.CustomFooterIcon"/> property to
1173 specify the icon to use.
1174 </para>
1175 <para>
1176 The footer icon is displayed only if the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.Footer"/> property is not an empty string ("").
1177 </para>
1178 </remarks>
1179 </member>
1180 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.CustomFooterIcon">
1181 <summary>
1182 Gets or sets a custom icon to display in the footer area of the task dialog.
1183 </summary>
1184 <value>
1185 An <see cref="T:System.Drawing.Icon"/> that represents the icon to display in the footer area of the task dialog,
1186 or <see langword="null"/> if no custom icon is used. The default value is <see langword="null"/>.
1187 </value>
1188 <remarks>
1189 <para>
1190 This property is ignored if the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.FooterIcon"/> property has a value other than <see cref="F:Ookii.Dialogs.Wpf.TaskDialogIcon.Custom"/>.
1191 </para>
1192 <para>
1193 The footer icon is displayed only if the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.Footer"/> property is not an empty string ("").
1194 </para>
1195 </remarks>
1196 </member>
1197 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.ButtonStyle">
1198 <summary>
1199 Gets or sets a value that indicates whether custom buttons should be displayed as normal buttons or command links.
1200 </summary>
1201 <value>
1202 A <see cref="T:Ookii.Dialogs.Wpf.TaskDialogButtonStyle"/> that indicates the display style of custom buttons on the dialog.
1203 The default value is <see cref="F:Ookii.Dialogs.Wpf.TaskDialogButtonStyle.Standard"/>.
1204 </value>
1205 <remarks>
1206 <para>
1207 This property affects only custom buttons, not standard ones.
1208 </para>
1209 <para>
1210 If a custom button is being displayed on a task dialog
1211 with <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ButtonStyle"/> set to <see cref="F:Ookii.Dialogs.Wpf.TaskDialogButtonStyle.CommandLinks"/>
1212 or <see cref="F:Ookii.Dialogs.Wpf.TaskDialogButtonStyle.CommandLinksNoIcon"/>, you delineate the command from the
1213 note by placing a line break in the string specified by <see cref="P:Ookii.Dialogs.Wpf.TaskDialogItem.Text"/> property.
1214 </para>
1215 </remarks>
1216 </member>
1217 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.VerificationText">
1218 <summary>
1219 Gets or sets the label for the verification checkbox.
1220 </summary>
1221 <value>
1222 The label for the verification checkbox, or an empty string ("") if no verification checkbox
1223 is shown. The default value is an empty string ("").
1224 </value>
1225 <remarks>
1226 If no text is set, the verification checkbox will not be shown.
1227 </remarks>
1228 </member>
1229 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.IsVerificationChecked">
1230 <summary>
1231 Gets or sets a value that indicates whether the verification checkbox is checked ot not.
1232 </summary>
1233 <value>
1234 <see langword="true"/> if the verficiation checkbox is checked; otherwise, <see langword="false"/>.
1235 </value>
1236 <remarks>
1237 <para>
1238 Set this property before displaying the dialog to determine the initial state of the check box.
1239 Use this property after displaying the dialog to determine whether the check box was checked when
1240 the user closed the dialog.
1241 </para>
1242 <note>
1243 This property is only used if <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.VerificationText"/> is not an empty string ("").
1244 </note>
1245 </remarks>
1246 </member>
1247 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedInformation">
1248 <summary>
1249 Gets or sets additional information to be displayed on the dialog.
1250 </summary>
1251 <value>
1252 Additional information to be displayed on the dialog. The default value is an empty string ("").
1253 </value>
1254 <remarks>
1255 <para>
1256 When this property is not an empty string (""), a control is shown on the task dialog that
1257 allows the user to expand and collapse the text specified in this property.
1258 </para>
1259 <para>
1260 The text is collapsed by default unless <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedByDefault"/> is set to <see langword="true"/>.
1261 </para>
1262 <para>
1263 The expanded text is shown in the main content area of the dialog, unless <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandFooterArea"/>
1264 is set to <see langword="true"/>, in which case it is shown in the footer area.
1265 </para>
1266 </remarks>
1267 </member>
1268 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedControlText">
1269 <summary>
1270 Gets or sets the text to use for the control for collapsing the expandable information specified in <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedInformation"/>.
1271 </summary>
1272 <value>
1273 The text to use for the control for collapsing the expandable information, or an empty string ("") if the
1274 operating system's default text is to be used. The default is an empty string ("")
1275 </value>
1276 <remarks>
1277 <para>
1278 If this text is not specified and <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.CollapsedControlText"/> is specified, the value of <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.CollapsedControlText"/>
1279 will be used for this property as well. If neither is specified, the operating system's default text is used.
1280 </para>
1281 <note>
1282 The control for collapsing or expanding the expandable information is displayed only if <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedInformation"/> is not
1283 an empty string ("")
1284 </note>
1285 </remarks>
1286 </member>
1287 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.CollapsedControlText">
1288 <summary>
1289 Gets or sets the text to use for the control for expading the expandable information specified in <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedInformation"/>.
1290 </summary>
1291 <value>
1292 The text to use for the control for expanding the expandable information, or an empty string ("") if the
1293 operating system's default text is to be used. The default is an empty string ("")
1294 </value>
1295 <remarks>
1296 <para>
1297 If this text is not specified and <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedControlText"/> is specified, the value of <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedControlText"/>
1298 will be used for this property as well. If neither is specified, the operating system's default text is used.
1299 </para>
1300 <note>
1301 The control for collapsing or expanding the expandable information is displayed only if <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedInformation"/> is not
1302 an empty string ("")
1303 </note>
1304 </remarks>
1305 </member>
1306 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.Footer">
1307 <summary>
1308 Gets or sets the text to be used in the footer area of the task dialog.
1309 </summary>
1310 <value>
1311 The text to be used in the footer area of the task dialog, or an empty string ("")
1312 if the footer area is not displayed. The default value is an empty string ("").
1313 </value>
1314 </member>
1315 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.Width">
1316 <summary>
1317 Specifies the width of the task dialog's client area in DLU's.
1318 </summary>
1319 <value>
1320 The width of the task dialog's client area in DLU's, or 0 to have the task dialog calculate the ideal width.
1321 The default value is 0.
1322 </value>
1323 </member>
1324 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.EnableHyperlinks">
1325 <summary>
1326 Gets or sets a value that indicates whether hyperlinks are allowed for the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.Content"/>, <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedInformation"/>
1327 and <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.Footer"/> properties.
1328 </summary>
1329 <value>
1330 <see langword="true"/> when hyperlinks are allowed for the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.Content"/>, <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedInformation"/>
1331 and <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.Footer"/> properties; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
1332 </value>
1333 <remarks>
1334 <para>
1335 When this property is <see langword="true"/>, the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.Content"/>, <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedInformation"/>
1336 and <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.Footer"/> properties can use hyperlinks in the following form: <c>&lt;A HREF="executablestring"&gt;Hyperlink Text&lt;/A&gt;</c>
1337 </para>
1338 <note>
1339 Enabling hyperlinks when using content from an unsafe source may cause security vulnerabilities.
1340 </note>
1341 <para>
1342 Task dialogs will not actually execute hyperlinks. To take action when the user presses a hyperlink, handle the
1343 <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.HyperlinkClicked"/> event.
1344 </para>
1345 </remarks>
1346 </member>
1347 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.AllowDialogCancellation">
1348 <summary>
1349 Gets or sets a value that indicates that the dialog should be able to be closed using Alt-F4, Escape and the title
1350 bar's close button even if no cancel button is specified.
1351 </summary>
1352 <value>
1353 <see langword="true" /> if the dialog can be closed using Alt-F4, Escape and the title
1354 bar's close button even if no cancel button is specified; otherwise, <see langword="false" />.
1355 The default value is <see langword="false" />.
1356 </value>
1357 </member>
1358 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandFooterArea">
1359 <summary>
1360 Gets or sets a value that indicates that the string specified by the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedInformation"/> property
1361 should be displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content.
1362 </summary>
1363 <value>
1364 <see langword="true"/> if the string specified by the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedInformation"/> property
1365 should be displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content;
1366 otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
1367 </value>
1368 </member>
1369 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedByDefault">
1370 <summary>
1371 Gets or sets a value that indicates that the string specified by the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedInformation"/> property
1372 should be displayed by default.
1373 </summary>
1374 <value>
1375 <see langword="true"/> if the string specified by the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ExpandedInformation"/> property
1376 should be displayed by default; <see langword="false"/> if it is hidden by default. The default value is
1377 <see langword="false"/>.
1378 </value>
1379 </member>
1380 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.RaiseTimerEvent">
1381 <summary>
1382 Gets or sets a value that indicates whether the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.Timer"/> event is raised periodically while the dialog
1383 is visible.
1384 </summary>
1385 <value>
1386 <see langword="true"/> when the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.Timer"/> event is raised periodically while the dialog is visible; otherwise,
1387 <see langword="false"/>. The default value is <see langword="false"/>.
1388 </value>
1389 <remarks>
1390 The <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.Timer"/> event will be raised approximately every 200 milliseconds if this property is <see langword="true"/>.
1391 </remarks>
1392 </member>
1393 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.CenterParent">
1394 <summary>
1395 Gets or sets a value that indicates whether the dialog is centered in the parent window instead of the screen.
1396 </summary>
1397 <value>
1398 <see langword="true" /> when the dialog is centered relative to the parent window; <see langword="false" /> when it is centered on the screen.
1399 The default value is <see langword="false" />.
1400 </value>
1401 </member>
1402 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.RightToLeft">
1403 <summary>
1404 Gets or sets a value that indicates whether text is displayed right to left.
1405 </summary>
1406 <value>
1407 <see langword="true" /> when the content of the dialog is displayed right to left; otherwise, <see langword="false" />.
1408 The default value is <see langword="false" />.
1409 </value>
1410 </member>
1411 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.MinimizeBox">
1412 <summary>
1413 Gets or sets a value that indicates whether the dialog has a minimize box on its caption bar.
1414 </summary>
1415 <value>
1416 <see langword="true" /> if the dialog has a minimize box on its caption bar when modeless; otherwise,
1417 <see langword="false" />. The default is <see langword="false" />.
1418 </value>
1419 <remarks>
1420 A task dialog can only have a minimize box if it is displayed as a modeless dialog. The minimize box
1421 will never appear when using the designer "Preview" option, since that displays the dialog modally.
1422 </remarks>
1423 </member>
1424 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarStyle">
1425 <summary>
1426 Gets or sets the type of progress bar displayed on the dialog.
1427 </summary>
1428 <value>
1429 A <see cref="T:Ookii.Dialogs.Wpf.ProgressBarStyle"/> that indicates the type of progress bar shown on the task dialog.
1430 </value>
1431 <remarks>
1432 <para>
1433 If this property is set to <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.MarqueeProgressBar"/>, the marquee will
1434 scroll as long as the dialog is visible.
1435 </para>
1436 <para>
1437 If this property is set to <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.ProgressBar"/>, the value of the
1438 <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarValue"/> property must be updated to advance the progress bar. This can be done e.g. by
1439 an asynchronous operation or from the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.Timer"/> event.
1440 </para>
1441 <note>
1442 Updating the value of the progress bar using the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarValue"/> while the dialog is visible property may only be done from
1443 the thread on which the task dialog was created.
1444 </note>
1445 </remarks>
1446 </member>
1447 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarMarqueeAnimationSpeed">
1448 <summary>
1449 Gets or sets the marquee animation speed of the progress bar in milliseconds.
1450 </summary>
1451 <value>
1452 The marquee animation speed of the progress bar in milliseconds. The default value is 100.
1453 </value>
1454 <remarks>
1455 This property is only used if the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarStyle"/> property is
1456 <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.MarqueeProgressBar"/>.
1457 </remarks>
1458 </member>
1459 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarMinimum">
1460 <summary>
1461 Gets or sets the lower bound of the range of the task dialog's progress bar.
1462 </summary>
1463 <value>
1464 The lower bound of the range of the task dialog's progress bar. The default value is 0.
1465 </value>
1466 <remarks>
1467 This property is only used if the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarStyle"/> property is
1468 <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.ProgressBar"/>.
1469 </remarks>
1470 <exception cref="T:System.ArgumentOutOfRangeException">The new property value is not smaller than <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarMaximum"/>.</exception>
1471 </member>
1472 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarMaximum">
1473 <summary>
1474 Gets or sets the upper bound of the range of the task dialog's progress bar.
1475 </summary>
1476 <value>
1477 The upper bound of the range of the task dialog's progress bar. The default value is 100.
1478 </value>
1479 <remarks>
1480 This property is only used if the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarStyle"/> property is
1481 <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.ProgressBar"/>.
1482 </remarks>
1483 <exception cref="T:System.ArgumentOutOfRangeException">The new property value is not larger than <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarMinimum"/>.</exception>
1484 </member>
1485 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarValue">
1486 <summary>
1487 Gets or sets the current value of the task dialog's progress bar.
1488 </summary>
1489 <value>
1490 The current value of the task dialog's progress bar. The default value is 0.
1491 </value>
1492 <remarks>
1493 This property is only used if the <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarStyle"/> property is
1494 <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.ProgressBar"/>.
1495 <note>
1496 Updating the value of the progress bar while the dialog is visible may only be done from
1497 the thread on which the task dialog was created.
1498 </note>
1499 </remarks>
1500 <exception cref="T:System.ArgumentOutOfRangeException">The new property value is smaller than <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarMinimum"/> or larger than <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarMaximum"/>.</exception>
1501 </member>
1502 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.ProgressBarState">
1503 <summary>
1504 Gets or sets the state of the task dialog's progress bar.
1505 </summary>
1506 <value>
1507 A <see cref="T:Ookii.Dialogs.Wpf.ProgressBarState"/> indicating the state of the task dialog's progress bar.
1508 The default value is <see cref="F:Ookii.Dialogs.Wpf.ProgressBarState.Normal"/>.
1509 </value>
1510 <remarks>
1511 This property is only used if the <see cref="T:Ookii.Dialogs.Wpf.ProgressBarStyle"/> property is
1512 <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.ProgressBar"/>.
1513 </remarks>
1514 </member>
1515 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.Tag">
1516 <summary>
1517 Gets or sets an object that contains data about the dialog.
1518 </summary>
1519 <value>
1520 An object that contains data about the dialog. The default value is <see langword="null" />.
1521 </value>
1522 <remarks>
1523 Use this property to store arbitrary information about the dialog.
1524 </remarks>
1525 </member>
1526 <member name="P:Ookii.Dialogs.Wpf.TaskDialog.Handle">
1527 <summary>
1528 Gets the window handle of the task dialog.
1529 </summary>
1530 <value>
1531 The window handle of the task dialog when it is being displayed, or <see cref="F:System.IntPtr.Zero"/> when the dialog
1532 is not being displayed.
1533 </value>
1534 </member>
1535 <member name="T:Ookii.Dialogs.Wpf.TaskDialogButtonStyle">
1536 <summary>
1537 Indicates the display style of custom buttons on a task dialog.
1538 </summary>
1539 </member>
1540 <member name="F:Ookii.Dialogs.Wpf.TaskDialogButtonStyle.Standard">
1541 <summary>
1542 Custom buttons are displayed as regular buttons.
1543 </summary>
1544 </member>
1545 <member name="F:Ookii.Dialogs.Wpf.TaskDialogButtonStyle.CommandLinks">
1546 <summary>
1547 Custom buttons are displayed as command links using a standard task dialog glyph.
1548 </summary>
1549 </member>
1550 <member name="F:Ookii.Dialogs.Wpf.TaskDialogButtonStyle.CommandLinksNoIcon">
1551 <summary>
1552 Custom buttons are displayed as command links without a glyph.
1553 </summary>
1554 </member>
1555 <member name="T:Ookii.Dialogs.Wpf.ShellAnimation">
1556 <summary>
1557 Resource identifiers for default animations from shell32.dll.
1558 </summary>
1559 </member>
1560 <member name="F:Ookii.Dialogs.Wpf.ShellAnimation.FileMove">
1561 <summary>
1562 An animation representing a file move.
1563 </summary>
1564 </member>
1565 <member name="F:Ookii.Dialogs.Wpf.ShellAnimation.FileCopy">
1566 <summary>
1567 An animation representing a file copy.
1568 </summary>
1569 </member>
1570 <member name="F:Ookii.Dialogs.Wpf.ShellAnimation.FlyingPapers">
1571 <summary>
1572 An animation showing flying papers.
1573 </summary>
1574 </member>
1575 <member name="F:Ookii.Dialogs.Wpf.ShellAnimation.SearchGlobe">
1576 <summary>
1577 An animation showing a magnifying glass over a globe.
1578 </summary>
1579 </member>
1580 <member name="F:Ookii.Dialogs.Wpf.ShellAnimation.PermanentDelete">
1581 <summary>
1582 An animation representing a permament delete.
1583 </summary>
1584 </member>
1585 <member name="F:Ookii.Dialogs.Wpf.ShellAnimation.FromRecycleBinDelete">
1586 <summary>
1587 An animation representing deleting an item from the recycle bin.
1588 </summary>
1589 </member>
1590 <member name="F:Ookii.Dialogs.Wpf.ShellAnimation.ToRecycleBinDelete">
1591 <summary>
1592 An animation representing a file move to the recycle bin.
1593 </summary>
1594 </member>
1595 <member name="F:Ookii.Dialogs.Wpf.ShellAnimation.SearchComputer">
1596 <summary>
1597 An animation representing a search spanning the local computer.
1598 </summary>
1599 </member>
1600 <member name="F:Ookii.Dialogs.Wpf.ShellAnimation.SearchDocument">
1601 <summary>
1602 An animation representing a search in a document..
1603 </summary>
1604 </member>
1605 <member name="F:Ookii.Dialogs.Wpf.ShellAnimation.SearchFlashlight">
1606 <summary>
1607 An animation representing a search using a flashlight animation.
1608 </summary>
1609 </member>
1610 <member name="T:Ookii.Dialogs.Wpf.VistaSaveFileDialog">
1611 <summary>
1612 Prompts the user to select a location for saving a file.
1613 </summary>
1614 <remarks>
1615 This class will use the Vista style save file dialog if possible, and automatically fall back to the old-style
1616 dialog on versions of Windows older than Vista.
1617 </remarks>
1618 <remarks>
1619 <para>
1620 Windows Vista provides a new style of common file dialog, with several new features (both from
1621 the user's and the programmers perspective).
1622 </para>
1623 <para>
1624 This class will use the Vista-style file dialogs if possible, and automatically fall back to the old-style
1625 dialog on versions of Windows older than Vista. This class is aimed at applications that
1626 target both Windows Vista and older versions of Windows, and therefore does not provide any
1627 of the new APIs provided by Vista's file dialogs.
1628 </para>
1629 <para>
1630 This class precisely duplicates the public interface of <see cref="T:Microsoft.Win32.SaveFileDialog"/> so you can just replace
1631 any instances of <see cref="T:Microsoft.Win32.SaveFileDialog"/> with the <see cref="T:Ookii.Dialogs.Wpf.VistaSaveFileDialog"/> without any further changes
1632 to your code.
1633 </para>
1634 </remarks>
1635 <threadsafety instance="false" static="true"/>
1636 </member>
1637 <member name="M:Ookii.Dialogs.Wpf.VistaSaveFileDialog.#ctor">
1638 <summary>
1639 Creates a new instance of <see cref="T:Ookii.Dialogs.Wpf.VistaSaveFileDialog"/> class.
1640 </summary>
1641 </member>
1642 <member name="M:Ookii.Dialogs.Wpf.VistaSaveFileDialog.Reset">
1643 <summary>
1644 Resets all properties to their default values.
1645 </summary>
1646 </member>
1647 <member name="M:Ookii.Dialogs.Wpf.VistaSaveFileDialog.OpenFile">
1648 <summary>
1649 Opens the file with read/write permission selected by the user.
1650 </summary>
1651 <returns>The read/write file selected by the user.</returns>
1652 <exception cref="T:System.ArgumentNullException">The file name is <see langword="null"/>.</exception>
1653 </member>
1654 <member name="M:Ookii.Dialogs.Wpf.VistaSaveFileDialog.OnFileOk(System.ComponentModel.CancelEventArgs)">
1655 <summary>
1656 Raises the <see cref="E:Ookii.Dialogs.Wpf.VistaFileDialog.FileOk"/> event.
1657 </summary>
1658 <param name="e">A <see cref="T:System.ComponentModel.CancelEventArgs"/> that contains the event data.</param>
1659 </member>
1660 <member name="P:Ookii.Dialogs.Wpf.VistaSaveFileDialog.CreatePrompt">
1661 <summary>
1662 Gets or sets a value indicating whether the dialog box prompts the user for permission to create a file if the
1663 user specifies a file that does not exist.
1664 </summary>
1665 <value>
1666 <see langword="true" /> if the dialog box prompts the user before creating a file if the user specifies a file name that does not exist;
1667 <see langword="false" /> if the dialog box automatically creates the new file without prompting the user for permission. The default
1668 value is <see langword="false" />.
1669 </value>
1670 </member>
1671 <member name="P:Ookii.Dialogs.Wpf.VistaSaveFileDialog.OverwritePrompt">
1672 <summary>
1673 Gets or sets a value indicating whether the Save As dialog box displays a warning if the user
1674 specifies a file name that already exists.
1675 </summary>
1676 <value>
1677 <see langword="true" /> if the dialog box prompts the user before overwriting an existing file if the user specifies a file
1678 name that already exists; <see langword="false" /> if the dialog box automatically overwrites the existing file without
1679 prompting the user for permission. The default value is <see langword="true" />.
1680 </value>
1681 </member>
1682 <member name="T:Ookii.Dialogs.Wpf.DownlevelTextMode">
1683 <summary>
1684 An enumeration that displays how the text in the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Content"/>
1685 properties is displayed on a credential dialog in Windows XP.
1686 </summary>
1687 <remarks>
1688 <para>
1689 Windows XP does not support the distinct visual style of the main instruction, so there is no visual difference between the
1690 text of the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Content"/> properties. Depending
1691 on the scenario, you may wish to hide either the main instruction or the content text.
1692 </para>
1693 </remarks>
1694 </member>
1695 <member name="F:Ookii.Dialogs.Wpf.DownlevelTextMode.MainInstructionAndContent">
1696 <summary>
1697 The text of the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Content"/> properties is
1698 concatenated together, separated by an empty line.
1699 </summary>
1700 </member>
1701 <member name="F:Ookii.Dialogs.Wpf.DownlevelTextMode.MainInstructionOnly">
1702 <summary>
1703 Only the text of the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction"/> property is shown.
1704 </summary>
1705 </member>
1706 <member name="F:Ookii.Dialogs.Wpf.DownlevelTextMode.ContentOnly">
1707 <summary>
1708 Only the text of the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Content"/> property is shown.
1709 </summary>
1710 </member>
1711 <member name="T:Ookii.Dialogs.Wpf.AnimationResource">
1712 <summary>
1713 Represents an animation for the <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> loaded from a Win32 resource.
1714 </summary>
1715 <threadsafety instance="false" static="true"/>
1716 </member>
1717 <member name="M:Ookii.Dialogs.Wpf.AnimationResource.#ctor(System.String,System.Int32)">
1718 <summary>
1719 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.AnimationResource"/> class.
1720 </summary>
1721 <param name="resourceFile">The file containing the animation resource.</param>
1722 <param name="resourceId">The resource ID of the animation resource.</param>
1723 <exception cref="T:System.ArgumentNullException"><paramref name="resourceFile"/> is <see langword="null"/>.</exception>
1724 </member>
1725 <member name="M:Ookii.Dialogs.Wpf.AnimationResource.GetShellAnimation(Ookii.Dialogs.Wpf.ShellAnimation)">
1726 <summary>
1727 Gets a default animation from shell32.dll.
1728 </summary>
1729 <param name="animation">The animation to get.</param>
1730 <returns>An instance of the <see cref="T:Ookii.Dialogs.Wpf.AnimationResource"/> class representing the specified animation.</returns>
1731 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="animation"/> parameter was not a value defined in the
1732 <see cref="T:Ookii.Dialogs.Wpf.ShellAnimation"/> enumeration.</exception>
1733 </member>
1734 <member name="P:Ookii.Dialogs.Wpf.AnimationResource.ResourceFile">
1735 <summary>
1736 Gets the name of the file containing the animation resource.
1737 </summary>
1738 <value>
1739 The name of the file containing the animation resource. This is typically a DLL or EXE file.
1740 </value>
1741 </member>
1742 <member name="P:Ookii.Dialogs.Wpf.AnimationResource.ResourceId">
1743 <summary>
1744 Gets the ID of the animation resource.
1745 </summary>
1746 <value>
1747 The ID of the animation resource.
1748 </value>
1749 </member>
1750 <member name="T:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog">
1751 <summary>
1752 Prompts the user to select a folder.
1753 </summary>
1754 <remarks>
1755 This class will use the Vista style Select Folder dialog if possible, or the regular FolderBrowserDialog
1756 if it is not. Note that the Vista style dialog is very different, so using this class without testing
1757 in both Vista and older Windows versions is not recommended.
1758 </remarks>
1759 <threadsafety instance="false" static="true" />
1760 </member>
1761 <member name="M:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog.#ctor">
1762 <summary>
1763 Creates a new instance of the <see cref="T:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog"/> class.
1764 </summary>
1765 </member>
1766 <member name="M:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog.Reset">
1767 <summary>
1768 Resets all properties to their default values.
1769 </summary>
1770 </member>
1771 <member name="M:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog.ShowDialog">
1772 <summary>
1773 Displays the folder browser dialog.
1774 </summary>
1775 <returns>If the user clicks the OK button, <see langword="true" /> is returned; otherwise, <see langword="false" />.</returns>
1776 </member>
1777 <member name="M:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog.ShowDialog(System.Windows.Window)">
1778 <summary>
1779 Displays the folder browser dialog.
1780 </summary>
1781 <param name="owner">Handle to the window that owns the dialog.</param>
1782 <returns>If the user clicks the OK button, <see langword="true" /> is returned; otherwise, <see langword="false" />.</returns>
1783 </member>
1784 <member name="P:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog.IsVistaFolderDialogSupported">
1785 <summary>
1786 Gets a value that indicates whether the current OS supports Vista-style common file dialogs.
1787 </summary>
1788 <value>
1789 <see langword="true" /> on Windows Vista or newer operating systems; otherwise, <see langword="false" />.
1790 </value>
1791 </member>
1792 <member name="P:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog.Description">
1793 <summary>
1794 Gets or sets the descriptive text displayed above the tree view control in the dialog box, or below the list view control
1795 in the Vista style dialog.
1796 </summary>
1797 <value>
1798 The description to display. The default is an empty string ("").
1799 </value>
1800 </member>
1801 <member name="P:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog.RootFolder">
1802 <summary>
1803 Gets or sets the root folder where the browsing starts from. This property has no effect if the Vista style
1804 dialog is used.
1805 </summary>
1806 <value>
1807 One of the <see cref="T:System.Environment.SpecialFolder"/> values. The default is Desktop.
1808 </value>
1809 <exception cref="T:System.ComponentModel.InvalidEnumArgumentException">The value assigned is not one of the <see cref="T:System.Environment.SpecialFolder"/> values.</exception>
1810 </member>
1811 <member name="P:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog.SelectedPath">
1812 <summary>
1813 Gets or sets the path selected by the user.
1814 </summary>
1815 <value>
1816 The path of the folder first selected in the dialog box or the last folder selected by the user. The default is an empty string ("").
1817 </value>
1818 </member>
1819 <member name="P:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog.ShowNewFolderButton">
1820 <summary>
1821 Gets or sets a value indicating whether the New Folder button appears in the folder browser dialog box. This
1822 property has no effect if the Vista style dialog is used; in that case, the New Folder button is always shown.
1823 </summary>
1824 <value>
1825 <see langword="true" /> if the New Folder button is shown in the dialog box; otherwise, <see langword="false" />. The default is <see langword="true" />.
1826 </value>
1827 </member>
1828 <member name="P:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog.UseDescriptionForTitle">
1829 <summary>
1830 Gets or sets a value that indicates whether to use the value of the <see cref="P:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog.Description"/> property
1831 as the dialog title for Vista style dialogs. This property has no effect on old style dialogs.
1832 </summary>
1833 <value><see langword="true"/> to indicate that the value of the <see cref="P:Ookii.Dialogs.Wpf.VistaFolderBrowserDialog.Description"/> property is used as dialog title; <see langword="false"/>
1834 to indicate the value is added as additional text to the dialog. The default is <see langword="false"/>.</value>
1835 </member>
1836 <member name="T:Ookii.Dialogs.Wpf.TaskDialogRadioButton">
1837 <summary>
1838 A radio button on a task dialog.
1839 </summary>
1840 <threadsafety static="true" instance="false" />
1841 </member>
1842 <member name="M:Ookii.Dialogs.Wpf.TaskDialogRadioButton.#ctor">
1843 <summary>
1844 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogRadioButton"/> class.
1845 </summary>
1846 </member>
1847 <member name="M:Ookii.Dialogs.Wpf.TaskDialogRadioButton.#ctor(System.ComponentModel.IContainer)">
1848 <summary>
1849 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogRadioButton"/> class with the specified container.
1850 </summary>
1851 <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogRadioButton"/> to.</param>
1852 </member>
1853 <member name="P:Ookii.Dialogs.Wpf.TaskDialogRadioButton.Checked">
1854 <summary>
1855 Gets or sets a value that indicates whether the radio button is checked.
1856 </summary>
1857 <value>
1858 <see langword="true"/> if the radio button is checked; otherwise, <see langword="false"/>.
1859 The default value is <see langword="false"/>.
1860 </value>
1861 <remarks>
1862 Setting this property while the dialog is being displayed has no effect. Instead, use the <see cref="M:Ookii.Dialogs.Wpf.TaskDialogItem.Click"/>
1863 method to check a particular radio button.
1864 </remarks>
1865 </member>
1866 <member name="P:Ookii.Dialogs.Wpf.TaskDialogRadioButton.ItemCollection">
1867 <summary>
1868 Gets the collection that items of this type are part of.
1869 </summary>
1870 <value>
1871 If the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogButton"/> is currently associated with a <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/>, the
1872 <see cref="P:Ookii.Dialogs.Wpf.TaskDialog.Buttons"/> collection of that <see cref="T:Ookii.Dialogs.Wpf.TaskDialog"/>; otherwise, <see langword="null"/>.
1873 </value>
1874 </member>
1875 <member name="T:Ookii.Dialogs.Wpf.TaskDialogIcon">
1876 <summary>
1877 Indicates the icon to use for a task dialog.
1878 </summary>
1879 </member>
1880 <member name="F:Ookii.Dialogs.Wpf.TaskDialogIcon.Custom">
1881 <summary>
1882 A custom icon or no icon if no custom icon is specified.
1883 </summary>
1884 </member>
1885 <member name="F:Ookii.Dialogs.Wpf.TaskDialogIcon.Warning">
1886 <summary>
1887 System warning icon.
1888 </summary>
1889 </member>
1890 <member name="F:Ookii.Dialogs.Wpf.TaskDialogIcon.Error">
1891 <summary>
1892 System Error icon.
1893 </summary>
1894 </member>
1895 <member name="F:Ookii.Dialogs.Wpf.TaskDialogIcon.Information">
1896 <summary>
1897 System Information icon.
1898 </summary>
1899 </member>
1900 <member name="F:Ookii.Dialogs.Wpf.TaskDialogIcon.Shield">
1901 <summary>
1902 Shield icon.
1903 </summary>
1904 </member>
1905 <member name="T:Ookii.Dialogs.Wpf.ExpandButtonClickedEventArgs">
1906 <summary>
1907 Provides data for the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.ExpandButtonClicked"/> event.
1908 </summary>
1909 <threadsafety instance="false" static="true"/>
1910 </member>
1911 <member name="M:Ookii.Dialogs.Wpf.ExpandButtonClickedEventArgs.#ctor(System.Boolean)">
1912 <summary>
1913 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.ExpandButtonClickedEventArgs"/> class with the specified expanded state.
1914 </summary>
1915 <param name="expanded"><see langword="true"/> if the the expanded content on the dialog is shown; otherwise, <see langword="false"/>.</param>
1916 </member>
1917 <member name="P:Ookii.Dialogs.Wpf.ExpandButtonClickedEventArgs.Expanded">
1918 <summary>
1919 Gets a value that indicates if the expanded content on the dialog is shown.
1920 </summary>
1921 <value><see langword="true" /> if the expanded content on the dialog is shown; otherwise, <see langword="false" />.</value>
1922 </member>
1923 <member name="T:Ookii.Dialogs.Wpf.CredentialDialog">
1924 <summary>
1925 Represents a dialog box that allows the user to enter generic credentials.
1926 </summary>
1927 <remarks>
1928 <para>
1929 This class is meant for generic credentials; it does not provide access to all the functionality
1930 of the Windows CredUI API. Features such as Windows domain credentials or alternative security
1931 providers (e.g. smartcards or biometric devices) are not supported.
1932 </para>
1933 <para>
1934 The <see cref="T:Ookii.Dialogs.Wpf.CredentialDialog"/> class provides methods for storing and retrieving credentials,
1935 and also manages automatic persistence of credentials by using the "Save password" checkbox on
1936 the credentials dialog. To specify the target for which the credentials should be saved, set the
1937 <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/> property.
1938 </para>
1939 <note>
1940 This class requires Windows XP or later.
1941 </note>
1942 </remarks>
1943 <threadsafety instance="false" static="true"/>
1944 </member>
1945 <member name="F:Ookii.Dialogs.Wpf.CredentialDialog.components">
1946 <summary>
1947 Required designer variable.
1948 </summary>
1949 </member>
1950 <member name="M:Ookii.Dialogs.Wpf.CredentialDialog.Dispose(System.Boolean)">
1951 <summary>
1952 Clean up any resources being used.
1953 </summary>
1954 <param name="disposing"><see langword="true"/> if managed resources should be disposed; otherwise, <see langword="false"/>.</param>
1955 </member>
1956 <member name="M:Ookii.Dialogs.Wpf.CredentialDialog.InitializeComponent">
1957 <summary>
1958 Required method for Designer support - do not modify
1959 the contents of this method with the code editor.
1960 </summary>
1961 </member>
1962 <member name="M:Ookii.Dialogs.Wpf.CredentialDialog.#ctor">
1963 <summary>
1964 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialDialog"/> class.
1965 </summary>
1966 </member>
1967 <member name="M:Ookii.Dialogs.Wpf.CredentialDialog.#ctor(System.ComponentModel.IContainer)">
1968 <summary>
1969 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialDialog"/> class with the specified container.
1970 </summary>
1971 <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the component to.</param>
1972 </member>
1973 <member name="M:Ookii.Dialogs.Wpf.CredentialDialog.ShowDialog">
1974 <summary>
1975 Shows the credentials dialog as a modal dialog.
1976 </summary>
1977 <returns><see langword="true"/> if the user clicked OK; otherwise, <see langword="false"/>.</returns>
1978 <remarks>
1979 <para>
1980 The credentials dialog will not be shown if one of the following conditions holds:
1981 </para>
1982 <list type="bullet">
1983 <item>
1984 <description>
1985 <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.UseApplicationInstanceCredentialCache"/> is <see langword="true"/> and the application instance
1986 credential cache contains credentials for the specified <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/>, even if <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowUIForSavedCredentials"/>
1987 is <see langword="true"/>.
1988 </description>
1989 </item>
1990 <item>
1991 <description>
1992 <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowSaveCheckBox"/> is <see langword="true"/>, <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowUIForSavedCredentials"/> is <see langword="false"/>, and the operating system credential store
1993 for the current user contains credentials for the specified <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/>.
1994 </description>
1995 </item>
1996 </list>
1997 <para>
1998 In these cases, the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Credentials"/>, <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.UserName"/> and <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Password"/> properties will
1999 be set to the saved credentials and this function returns immediately, returning <see langword="true"/>.
2000 </para>
2001 <para>
2002 If the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowSaveCheckBox"/> property is <see langword="true"/>, you should call <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.ConfirmCredentials(System.Boolean)"/>
2003 after validating if the provided credentials are correct.
2004 </para>
2005 </remarks>
2006 <exception cref="T:Ookii.Dialogs.Wpf.CredentialException">An error occurred while showing the credentials dialog.</exception>
2007 <exception cref="T:System.InvalidOperationException"><see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/> is an empty string ("").</exception>
2008 </member>
2009 <member name="M:Ookii.Dialogs.Wpf.CredentialDialog.ShowDialog(System.Windows.Window)">
2010 <summary>
2011 Shows the credentials dialog as a modal dialog with the specified owner.
2012 </summary>
2013 <param name="owner">The <see cref="T:System.Windows.Window"/> that owns the credentials dialog.</param>
2014 <returns><see langword="true"/> if the user clicked OK; otherwise, <see langword="false"/>.</returns>
2015 <remarks>
2016 <para>
2017 The credentials dialog will not be shown if one of the following conditions holds:
2018 </para>
2019 <list type="bullet">
2020 <item>
2021 <description>
2022 <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.UseApplicationInstanceCredentialCache"/> is <see langword="true"/> and the application instance
2023 credential cache contains credentials for the specified <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/>, even if <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowUIForSavedCredentials"/>
2024 is <see langword="true"/>.
2025 </description>
2026 </item>
2027 <item>
2028 <description>
2029 <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowSaveCheckBox"/> is <see langword="true"/>, <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowUIForSavedCredentials"/> is <see langword="false"/>, and the operating system credential store
2030 for the current user contains credentials for the specified <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/>.
2031 </description>
2032 </item>
2033 </list>
2034 <para>
2035 In these cases, the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Credentials"/>, <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.UserName"/> and <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Password"/> properties will
2036 be set to the saved credentials and this function returns immediately, returning <see langword="true"/>.
2037 </para>
2038 <para>
2039 If the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowSaveCheckBox"/> property is <see langword="true"/>, you should call <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.ConfirmCredentials(System.Boolean)"/>
2040 after validating if the provided credentials are correct.
2041 </para>
2042 </remarks>
2043 <exception cref="T:Ookii.Dialogs.Wpf.CredentialException">An error occurred while showing the credentials dialog.</exception>
2044 <exception cref="T:System.InvalidOperationException"><see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/> is an empty string ("").</exception>
2045 </member>
2046 <member name="M:Ookii.Dialogs.Wpf.CredentialDialog.ConfirmCredentials(System.Boolean)">
2047 <summary>
2048 Confirms the validity of the credential provided by the user.
2049 </summary>
2050 <param name="confirm"><see langword="true"/> if the credentials that were specified on the dialog are valid; otherwise, <see langword="false"/>.</param>
2051 <remarks>
2052 Call this function after calling <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.ShowDialog"/> when <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowSaveCheckBox"/> is <see langword="true"/>.
2053 Only when this function is called with <paramref name="confirm"/> set to <see langword="true"/> will the credentials be
2054 saved in the credentials store and/or the application instance credential cache.
2055 </remarks>
2056 <exception cref="T:System.InvalidOperationException"><see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.ShowDialog"/> was not called, or the user did not click OK, or <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowSaveCheckBox"/> was <see langword="false"/>
2057 at the call, or the value of <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/> or <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.IsSaveChecked"/>
2058 was changed after the call.</exception>
2059 <exception cref="T:Ookii.Dialogs.Wpf.CredentialException">There was an error saving the credentials.</exception>
2060 </member>
2061 <member name="M:Ookii.Dialogs.Wpf.CredentialDialog.StoreCredential(System.String,System.Net.NetworkCredential)">
2062 <summary>
2063 Stores the specified credentials in the operating system's credential store for the currently logged on user.
2064 </summary>
2065 <param name="target">The target name for the credentials.</param>
2066 <param name="credential">The credentials to store.</param>
2067 <exception cref="T:System.ArgumentNullException">
2068 <para>
2069 <paramref name="target"/> is <see langword="null"/>.
2070 </para>
2071 <para>
2072 -or-
2073 </para>
2074 <para>
2075 <paramref name="credential"/> is <see langword="null"/>.
2076 </para>
2077 </exception>
2078 <exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>
2079 <exception cref="T:Ookii.Dialogs.Wpf.CredentialException">An error occurred storing the credentials.</exception>
2080 <remarks>
2081 <note>
2082 The <see cref="P:System.Net.NetworkCredential.Domain"/> property is ignored and will not be stored, even if it is
2083 not <see langword="null"/>.
2084 </note>
2085 <para>
2086 If the credential manager already contains credentials for the specified <paramref name="target"/>, they
2087 will be overwritten; this can even overwrite credentials that were stored by another application. Therefore
2088 it is strongly recommended that you prefix the target name to ensure uniqueness, e.g. using the
2089 form "Company_ApplicationName_www.example.com".
2090 </para>
2091 </remarks>
2092 </member>
2093 <member name="M:Ookii.Dialogs.Wpf.CredentialDialog.RetrieveCredential(System.String)">
2094 <summary>
2095 Retrieves credentials for the specified target from the operating system's credential store for the current user.
2096 </summary>
2097 <param name="target">The target name for the credentials.</param>
2098 <returns>The credentials if they were found; otherwise, <see langword="null"/>.</returns>
2099 <remarks>
2100 <para>
2101 If the requested credential was not originally stored using the <see cref="T:Ookii.Dialogs.Wpf.CredentialDialog"/> class (but e.g. by
2102 another application), the password may not be decoded correctly.
2103 </para>
2104 <para>
2105 This function does not check the application instance credential cache for the credentials; for that you can use
2106 the <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.RetrieveCredentialFromApplicationInstanceCache(System.String)"/> function.
2107 </para>
2108 </remarks>
2109 <exception cref="T:System.ArgumentNullException"><paramref name="target"/> is <see langword="null"/>.</exception>
2110 <exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>
2111 <exception cref="T:Ookii.Dialogs.Wpf.CredentialException">An error occurred retrieving the credentials.</exception>
2112 </member>
2113 <member name="M:Ookii.Dialogs.Wpf.CredentialDialog.RetrieveCredentialFromApplicationInstanceCache(System.String)">
2114 <summary>
2115 Tries to get the credentials for the specified target from the application instance credential cache.
2116 </summary>
2117 <param name="target">The target for the credentials, typically a server name.</param>
2118 <returns>The credentials that were found in the application instance cache; otherwise, <see langword="null"/>.</returns>
2119 <remarks>
2120 <para>
2121 This function will only check the the application instance credential cache; the operating system's credential store
2122 is not checked. To retrieve credentials from the operating system's store, use <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.RetrieveCredential(System.String)"/>.
2123 </para>
2124 </remarks>
2125 <exception cref="T:System.ArgumentNullException"><paramref name="target"/> is <see langword="null"/>.</exception>
2126 <exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>
2127 </member>
2128 <member name="M:Ookii.Dialogs.Wpf.CredentialDialog.DeleteCredential(System.String)">
2129 <summary>
2130 Deletes the credentials for the specified target.
2131 </summary>
2132 <param name="target">The name of the target for which to delete the credentials.</param>
2133 <returns><see langword="true"/> if the credential was deleted from either the application instance cache or
2134 the operating system's store; <see langword="false"/> if no credentials for the specified target could be found
2135 in either store.</returns>
2136 <remarks>
2137 <para>
2138 The credentials for the specified target will be removed from the application instance credential cache
2139 and the operating system's credential store.
2140 </para>
2141 </remarks>
2142 <exception cref="T:System.ArgumentNullException"><paramref name="target"/> is <see langword="null"/>.</exception>
2143 <exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>
2144 <exception cref="T:Ookii.Dialogs.Wpf.CredentialException">An error occurred deleting the credentials from the operating system's credential store.</exception>
2145 </member>
2146 <member name="M:Ookii.Dialogs.Wpf.CredentialDialog.OnUserNameChanged(System.EventArgs)">
2147 <summary>
2148 Raises the <see cref="E:Ookii.Dialogs.Wpf.CredentialDialog.UserNameChanged"/> event.
2149 </summary>
2150 <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>
2151 </member>
2152 <member name="M:Ookii.Dialogs.Wpf.CredentialDialog.OnPasswordChanged(System.EventArgs)">
2153 <summary>
2154 Raises the <see cref="E:Ookii.Dialogs.Wpf.CredentialDialog.PasswordChanged"/> event.
2155 </summary>
2156 <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>
2157 </member>
2158 <member name="E:Ookii.Dialogs.Wpf.CredentialDialog.UserNameChanged">
2159 <summary>
2160 Event raised when the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.UserName"/> property changes.
2161 </summary>
2162 </member>
2163 <member name="E:Ookii.Dialogs.Wpf.CredentialDialog.PasswordChanged">
2164 <summary>
2165 Event raised when the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Password"/> property changes.
2166 </summary>
2167 </member>
2168 <member name="P:Ookii.Dialogs.Wpf.CredentialDialog.UseApplicationInstanceCredentialCache">
2169 <summary>
2170 Gets or sets whether to use the application instance credential cache.
2171 </summary>
2172 <value>
2173 <see langword="true"/> when credentials are saved in the application instance cache; <see langref="false"/> if they are not.
2174 The default value is <see langword="false"/>.
2175 </value>
2176 <remarks>
2177 <para>
2178 The application instance credential cache stores credentials in memory while an application is running. When the
2179 application exits, this cache is not persisted.
2180 </para>
2181 <para>
2182 When the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.UseApplicationInstanceCredentialCache"/> property is set to <see langword="true"/>, credentials that
2183 are confirmed with <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.ConfirmCredentials(System.Boolean)"/> when the user checked the "save password" option will be stored
2184 in the application instance cache as well as the operating system credential store.
2185 </para>
2186 <para>
2187 When <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.ShowDialog"/> is called, and credentials for the specified <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/> are already present in
2188 the application instance cache, the dialog will not be shown and the cached credentials are returned, even if
2189 <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowUIForSavedCredentials"/> is <see langword="true"/>.
2190 </para>
2191 <para>
2192 The application instance credential cache allows you to prevent prompting the user again for the lifetime of the
2193 application if the "save password" checkbox was checked, but when the application is restarted you can prompt again
2194 (initializing the dialog with the saved credentials). To get this behaviour, the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowUIForSavedCredentials"/>
2195 property must be set to <see langword="true"/>.
2196 </para>
2197 </remarks>
2198 </member>
2199 <member name="P:Ookii.Dialogs.Wpf.CredentialDialog.IsSaveChecked">
2200 <summary>
2201 Gets or sets whether the "save password" checkbox is checked.
2202 </summary>
2203 <value>
2204 <see langword="true" /> if the "save password" is checked; otherwise, <see langword="false" />.
2205 The default value is <see langword="false" />.
2206 </value>
2207 <remarks>
2208 The value of this property is only valid if the dialog box is displayed with a save checkbox.
2209 Set this property before showing the dialog to determine the initial checked value of the save checkbox.
2210 </remarks>
2211 </member>
2212 <member name="P:Ookii.Dialogs.Wpf.CredentialDialog.Password">
2213 <summary>
2214 Gets the password the user entered in the dialog.
2215 </summary>
2216 <value>
2217 The password entered in the password field of the credentials dialog.
2218 </value>
2219 </member>
2220 <member name="P:Ookii.Dialogs.Wpf.CredentialDialog.Credentials">
2221 <summary>
2222 Gets the user-specified user name and password in a <see cref="T:System.Net.NetworkCredential"/> object.
2223 </summary>
2224 <value>
2225 A <see cref="T:System.Net.NetworkCredential"/> instance containing the user name and password specified on the dialog.
2226 </value>
2227 </member>
2228 <member name="P:Ookii.Dialogs.Wpf.CredentialDialog.UserName">
2229 <summary>
2230 Gets the user name the user entered in the dialog.
2231 </summary>
2232 <value>
2233 The user name entered in the user name field of the credentials dialog.
2234 The default value is an empty string ("").
2235 </value>
2236 </member>
2237 <member name="P:Ookii.Dialogs.Wpf.CredentialDialog.Target">
2238 <summary>
2239 Gets or sets the target for the credentials, typically a server name.
2240 </summary>
2241 <value>
2242 The target for the credentials. The default value is an empty string ("").
2243 </value>
2244 <remarks>
2245 Credentials are stored on a per user, not on a per application basis. To ensure that credentials stored by different
2246 applications do not conflict, you should prefix the target with an application-specific identifer, e.g.
2247 "Company_Application_target".
2248 </remarks>
2249 </member>
2250 <member name="P:Ookii.Dialogs.Wpf.CredentialDialog.WindowTitle">
2251 <summary>
2252 Gets or sets the title of the credentials dialog.
2253 </summary>
2254 <value>
2255 The title of the credentials dialog. The default value is an empty string ("").
2256 </value>
2257 <remarks>
2258 <para>
2259 This property is not used on Windows Vista and newer versions of windows; the window title will always be "Windows Security"
2260 in that case.
2261 </para>
2262 </remarks>
2263 </member>
2264 <member name="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction">
2265 <summary>
2266 Gets or sets a brief message to display in the dialog box.
2267 </summary>
2268 <value>
2269 A brief message that will be displayed in the dialog box. The default value is an empty string ("").
2270 </value>
2271 <remarks>
2272 <para>
2273 On Windows Vista and newer versions of Windows, this text is displayed using a different style to set it apart
2274 from the other text. In the default style, this text is a slightly larger and colored blue. The style is identical
2275 to the main instruction of a task dialog.
2276 </para>
2277 <para>
2278 On Windows XP, this text is not distinguished from other text. It's display mode depends on the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.DownlevelTextMode"/>
2279 property.
2280 </para>
2281 </remarks>
2282 </member>
2283 <member name="P:Ookii.Dialogs.Wpf.CredentialDialog.Content">
2284 <summary>
2285 Gets or sets additional text to display in the dialog.
2286 </summary>
2287 <value>
2288 Additional text to display in the dialog. The default value is an empty string ("").
2289 </value>
2290 <remarks>
2291 <para>
2292 On Windows Vista and newer versions of Windows, this text is placed below the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction"/> text.
2293 </para>
2294 <para>
2295 On Windows XP, how and if this text is displayed depends on the value of the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.DownlevelTextMode"/>
2296 property.
2297 </para>
2298 </remarks>
2299 </member>
2300 <member name="P:Ookii.Dialogs.Wpf.CredentialDialog.DownlevelTextMode">
2301 <summary>
2302 Gets or sets a value that indicates how the text of the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Content"/> properties
2303 is displayed on Windows XP.
2304 </summary>
2305 <value>
2306 One of the values of the <see cref="T:Ookii.Dialogs.Wpf.DownlevelTextMode"/> enumeration. The default value is
2307 <see cref="F:Ookii.Dialogs.Wpf.DownlevelTextMode.MainInstructionAndContent"/>.
2308 </value>
2309 <remarks>
2310 <para>
2311 Windows XP does not support the distinct visual style of the main instruction, so there is no visual difference between the
2312 text of the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Content"/> properties. Depending
2313 on your requirements, you may wish to hide either the main instruction or the content text.
2314 </para>
2315 <para>
2316 This property has no effect on Windows Vista and newer versions of Windows.
2317 </para>
2318 </remarks>
2319 </member>
2320 <member name="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowSaveCheckBox">
2321 <summary>
2322 Gets or sets a value that indicates whether a check box is shown on the dialog that allows the user to choose whether to save
2323 the credentials or not.
2324 </summary>
2325 <value>
2326 <see langword="true"/> when the "save password" checkbox is shown on the credentials dialog; otherwise, <see langword="false"/>.
2327 The default value is <see langword="false"/>.
2328 </value>
2329 <remarks>
2330 When this property is set to <see langword="true"/>, you must call the <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.ConfirmCredentials(System.Boolean)"/> method to save the
2331 credentials. When this property is set to <see langword="false"/>, the credentials will never be saved, and you should not call
2332 the <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.ConfirmCredentials(System.Boolean)"/> method.
2333 </remarks>
2334 </member>
2335 <member name="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowUIForSavedCredentials">
2336 <summary>
2337 Gets or sets a value that indicates whether the dialog should be displayed even when saved credentials exist for the
2338 specified target.
2339 </summary>
2340 <value>
2341 <see langword="true"/> if the dialog is displayed even when saved credentials exist; otherwise, <see langword="false"/>.
2342 The default value is <see langword="false"/>.
2343 </value>
2344 <remarks>
2345 <para>
2346 This property applies only when the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowSaveCheckBox"/> property is <see langword="true"/>.
2347 </para>
2348 <para>
2349 Note that even if this property is <see langword="true"/>, if the proper credentials exist in the
2350 application instance credentials cache the dialog will not be displayed.
2351 </para>
2352 </remarks>
2353 </member>
2354 <member name="P:Ookii.Dialogs.Wpf.CredentialDialog.IsStoredCredential">
2355 <summary>
2356 Gets a value that indicates whether the current credentials were retrieved from a credential store.
2357 </summary>
2358 <value>
2359 <see langword="true"/> if the current credentials returned by the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.UserName"/>, <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Password"/>,
2360 and <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Credentials"/> properties were retrieved from either the application instance credential cache
2361 or the operating system's credential store; otherwise, <see langword="false"/>.
2362 </value>
2363 <remarks>
2364 <para>
2365 You can use this property to determine if the credentials dialog was shown after a call to <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.ShowDialog"/>.
2366 If the dialog was shown, this property will be <see langword="false"/>; if the credentials were retrieved from the
2367 application instance cache or the credential store and the dialog was not shown it will be <see langword="true"/>.
2368 </para>
2369 <para>
2370 If the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowUIForSavedCredentials"/> property is set to <see langword="true"/>, and the dialog is shown
2371 but populated with stored credentials, this property will still return <see langword="false"/>.
2372 </para>
2373 </remarks>
2374 </member>
2375 <member name="T:Ookii.Dialogs.Wpf.TimerEventArgs">
2376 <summary>
2377 Provides data for the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.Timer"/> event.
2378 </summary>
2379 <threadsafety instance="false" static="true"/>
2380 </member>
2381 <member name="M:Ookii.Dialogs.Wpf.TimerEventArgs.#ctor(System.Int32)">
2382 <summary>
2383 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.TimerEventArgs"/> class with the specified tick count.
2384 </summary>
2385 <param name="tickCount">The tick count.</param>
2386 </member>
2387 <member name="P:Ookii.Dialogs.Wpf.TimerEventArgs.ResetTickCount">
2388 <summary>
2389 Gets or sets a value that indicates whether the tick count should be reset.
2390 </summary>
2391 <value>
2392 <see langword="true" /> to reset the tick count after the event handler returns; otherwise, <see langword="false" />.
2393 The default value is <see langword="false" />.
2394 </value>
2395 </member>
2396 <member name="P:Ookii.Dialogs.Wpf.TimerEventArgs.TickCount">
2397 <summary>
2398 Gets the current tick count of the timer.
2399 </summary>
2400 <value>
2401 The number of milliseconds that has elapsed since the dialog was created or since the last time the event handler returned
2402 with the <see cref="P:Ookii.Dialogs.Wpf.TimerEventArgs.ResetTickCount"/> property set to <see langword="true"/>.
2403 </value>
2404 </member>
2405 <member name="T:Ookii.Dialogs.Wpf.ProgressDialog">
2406 <summary>
2407 Represents a dialog that can be used to report progress to the user.
2408 </summary>
2409 <remarks>
2410 <para>
2411 This class provides a wrapper for the native Windows IProgressDialog API.
2412 </para>
2413 <para>
2414 The <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> class requires Windows 2000, Windows Me, or newer versions of Windows.
2415 </para>
2416 </remarks>
2417 <threadsafety static="true" instance="false"/>
2418 </member>
2419 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.#ctor">
2420 <summary>
2421 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> class.
2422 </summary>
2423 </member>
2424 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.#ctor(System.ComponentModel.IContainer)">
2425 <summary>
2426 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> class, adding it to the specified container.
2427 </summary>
2428 <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to which the component should be added.</param>
2429 </member>
2430 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.Show">
2431 <summary>
2432 Displays the progress dialog as a modeless dialog.
2433 </summary>
2434 <remarks>
2435 <para>
2436 This function will not block the parent window and will return immediately.
2437 </para>
2438 <para>
2439 Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
2440 will not function correctly unless the UI thread continues to handle window messages, so that thread may
2441 not be blocked by some other activity. All processing related to the progress dialog must be done in
2442 the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event handler.
2443 </para>
2444 </remarks>
2445 <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.Wpf.ProgressDialog.Animation"/> property
2446 could not be loaded.</exception>
2447 </member>
2448 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.Show(System.Object)">
2449 <summary>
2450 Displays the progress dialog as a modeless dialog.
2451 </summary>
2452 <param name="argument">A parameter for use by the background operation to be executed in the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event handler.</param>
2453 <remarks>
2454 <para>
2455 This function will not block the parent window and return immediately.
2456 </para>
2457 <para>
2458 Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
2459 will not function correctly unless the UI thread continues to handle window messages, so that thread may
2460 not be blocked by some other activity. All processing related to the progress dialog must be done in
2461 the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event handler.
2462 </para>
2463 </remarks>
2464 <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.Wpf.ProgressDialog.Animation"/> property
2465 could not be loaded.</exception>
2466 </member>
2467 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.ShowDialog">
2468 <summary>
2469 Displays the progress dialog as a modal dialog.
2470 </summary>
2471 <remarks>
2472 <para>
2473 The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However,
2474 the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ShowDialog"/> function for the <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> class will return immediately.
2475 The parent window will be disabled as with all modal dialogs.
2476 </para>
2477 <para>
2478 Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
2479 will not function correctly unless the UI thread continues to handle window messages, so that thread may
2480 not be blocked by some other activity. All processing related to the progress dialog must be done in
2481 the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event handler.
2482 </para>
2483 <para>
2484 The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs,
2485 but is part of the underlying native progress dialog API so cannot be avoided.
2486 </para>
2487 <para>
2488 When possible, it is recommended that you use a modeless dialog using the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.Show"/> function.
2489 </para>
2490 </remarks>
2491 <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.Wpf.ProgressDialog.Animation"/> property
2492 could not be loaded.</exception>
2493 </member>
2494 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.ShowDialog(System.Windows.Window)">
2495 <summary>
2496 Displays the progress dialog as a modal dialog.
2497 </summary>
2498 <param name="owner">The window that owns the dialog.</param>
2499 <remarks>
2500 <para>
2501 The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However,
2502 the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ShowDialog"/> function for the <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> class will return immediately.
2503 The parent window will be disabled as with all modal dialogs.
2504 </para>
2505 <para>
2506 Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
2507 will not function correctly unless the UI thread continues to handle window messages, so that thread may
2508 not be blocked by some other activity. All processing related to the progress dialog must be done in
2509 the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event handler.
2510 </para>
2511 <para>
2512 The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs,
2513 but is part of the underlying native progress dialog API so cannot be avoided.
2514 </para>
2515 <para>
2516 When possible, it is recommended that you use a modeless dialog using the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.Show"/> function.
2517 </para>
2518 </remarks>
2519 <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.Wpf.ProgressDialog.Animation"/> property
2520 could not be loaded, or the operation is already running.</exception>
2521 </member>
2522 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.ShowDialog(System.Windows.Window,System.Object)">
2523 <summary>
2524 Displays the progress dialog as a modal dialog.
2525 </summary>
2526 <param name="owner">The window that owns the dialog.</param>
2527 <param name="argument">A parameter for use by the background operation to be executed in the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event handler.</param>
2528 <remarks>
2529 <para>
2530 The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However,
2531 the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ShowDialog"/> function for the <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> class will return immediately.
2532 The parent window will be disabled as with all modal dialogs.
2533 </para>
2534 <para>
2535 Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
2536 will not function correctly unless the UI thread continues to handle window messages, so that thread may
2537 not be blocked by some other activity. All processing related to the progress dialog must be done in
2538 the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event handler.
2539 </para>
2540 <para>
2541 The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs,
2542 but is part of the underlying native progress dialog API so cannot be avoided.
2543 </para>
2544 <para>
2545 When possible, it is recommended that you use a modeless dialog using the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.Show"/> function.
2546 </para>
2547 </remarks>
2548 <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.Wpf.ProgressDialog.Animation"/> property
2549 could not be loaded, or the operation is already running.</exception>
2550 </member>
2551 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.ReportProgress(System.Int32)">
2552 <summary>
2553 Updates the dialog's progress bar.
2554 </summary>
2555 <param name="percentProgress">The percentage, from 0 to 100, of the operation that is complete.</param>
2556 <remarks>
2557 <para>
2558 Call this method from the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event handler if you want to report progress.
2559 </para>
2560 <para>
2561 This method has no effect is <see cref="P:Ookii.Dialogs.Wpf.ProgressDialog.ProgressBarStyle"/> is <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.MarqueeProgressBar"/>
2562 or <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.None"/>.
2563 </para>
2564 </remarks>
2565 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="percentProgress"/> is out of range.</exception>
2566 <exception cref="T:System.InvalidOperationException">The progress dialog is not currently being displayed.</exception>
2567 </member>
2568 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)">
2569 <summary>
2570 Updates the dialog's progress bar.
2571 </summary>
2572 <param name="percentProgress">The percentage, from 0 to 100, of the operation that is complete.</param>
2573 <param name="text">The new value of the progress dialog's primary text message, or <see langword="null"/> to leave the value unchanged.</param>
2574 <param name="description">The new value of the progress dialog's additional description message, or <see langword="null"/> to leave the value unchanged.</param>
2575 <remarks>Call this method from the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event handler if you want to report progress.</remarks>
2576 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="percentProgress"/> is out of range.</exception>
2577 <exception cref="T:System.InvalidOperationException">The progress dialog is not currently being displayed.</exception>
2578 </member>
2579 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.ReportProgress(System.Int32,System.String,System.String,System.Object)">
2580 <summary>
2581 Updates the dialog's progress bar.
2582 </summary>
2583 <param name="percentProgress">The percentage, from 0 to 100, of the operation that is complete.</param>
2584 <param name="text">The new value of the progress dialog's primary text message, or <see langword="null"/> to leave the value unchanged.</param>
2585 <param name="description">The new value of the progress dialog's additional description message, or <see langword="null"/> to leave the value unchanged.</param>
2586 <param name="userState">A state object that will be passed to the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.ProgressChanged"/> event handler.</param>
2587 <remarks>Call this method from the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event handler if you want to report progress.</remarks>
2588 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="percentProgress"/> is out of range.</exception>
2589 <exception cref="T:System.InvalidOperationException">The progress dialog is not currently being displayed.</exception>
2590 </member>
2591 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.OnDoWork(System.ComponentModel.DoWorkEventArgs)">
2592 <summary>
2593 Raises the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event.
2594 </summary>
2595 <param name="e">The <see cref="T:System.ComponentModel.DoWorkEventArgs"/> containing data for the event.</param>
2596 </member>
2597 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.OnRunWorkerCompleted(System.ComponentModel.RunWorkerCompletedEventArgs)">
2598 <summary>
2599 Raises the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.RunWorkerCompleted"/> event.
2600 </summary>
2601 <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>
2602 </member>
2603 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.OnProgressChanged(System.ComponentModel.ProgressChangedEventArgs)">
2604 <summary>
2605 Raises the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.ProgressChanged"/> event.
2606 </summary>
2607 <param name="e">The <see cref="T:System.ComponentModel.ProgressChangedEventArgs"/> containing data for the event.</param>
2608 </member>
2609 <member name="F:Ookii.Dialogs.Wpf.ProgressDialog.components">
2610 <summary>
2611 Required designer variable.
2612 </summary>
2613 </member>
2614 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.Dispose(System.Boolean)">
2615 <summary>
2616 Clean up any resources being used.
2617 </summary>
2618 <param name="disposing"><see langword="true" /> if managed resources should be disposed; otherwise, <see langword="false" />.</param>
2619 </member>
2620 <member name="M:Ookii.Dialogs.Wpf.ProgressDialog.InitializeComponent">
2621 <summary>
2622 Required method for Designer support - do not modify
2623 the contents of this method with the code editor.
2624 </summary>
2625 </member>
2626 <member name="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork">
2627 <summary>
2628 Event raised when the dialog is displayed.
2629 </summary>
2630 <remarks>
2631 Use this event to perform the operation that the dialog is showing the progress for.
2632 This event will be raised on a different thread than the UI thread.
2633 </remarks>
2634 </member>
2635 <member name="E:Ookii.Dialogs.Wpf.ProgressDialog.RunWorkerCompleted">
2636 <summary>
2637 Event raised when the operation completes.
2638 </summary>
2639 </member>
2640 <member name="E:Ookii.Dialogs.Wpf.ProgressDialog.ProgressChanged">
2641 <summary>
2642 Event raised when <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ReportProgress(System.Int32,System.String,System.String,System.Object)"/> is called.
2643 </summary>
2644 </member>
2645 <member name="P:Ookii.Dialogs.Wpf.ProgressDialog.WindowTitle">
2646 <summary>
2647 Gets or sets the text in the progress dialog's title bar.
2648 </summary>
2649 <value>
2650 The text in the progress dialog's title bar. The default value is an empty string.
2651 </value>
2652 <remarks>
2653 <para>
2654 This property must be set before <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.Show"/> is called. Changing property has
2655 no effect while the dialog is being displayed.
2656 </para>
2657 </remarks>
2658 </member>
2659 <member name="P:Ookii.Dialogs.Wpf.ProgressDialog.Text">
2660 <summary>
2661 Gets or sets a short description of the operation being carried out.
2662 </summary>
2663 <value>
2664 A short description of the operation being carried. The default value is an empty string.
2665 </value>
2666 <remarks>
2667 <para>
2668 This is the primary message to the user.
2669 </para>
2670 <para>
2671 This property can be changed while the dialog is running, but may only be changed from the thread which
2672 created the progress dialog. The recommended method to change this value while the dialog is running
2673 is to use the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)"/> method.
2674 </para>
2675 </remarks>
2676 </member>
2677 <member name="P:Ookii.Dialogs.Wpf.ProgressDialog.UseCompactPathsForText">
2678 <summary>
2679 Gets or sets a value that indicates whether path strings in the <see cref="P:Ookii.Dialogs.Wpf.ProgressDialog.Text"/> property should be compacted if
2680 they are too large to fit on one line.
2681 </summary>
2682 <value>
2683 <see langword="true"/> to compact path strings if they are too large to fit on one line; otherwise,
2684 <see langword="false"/>. The default value is <see langword="false"/>.
2685 </value>
2686 <remarks>
2687 <note>
2688 This property requires Windows Vista or later. On older versions of Windows, it has no effect.
2689 </note>
2690 <para>
2691 This property can be changed while the dialog is running, but may only be changed from the thread which
2692 created the progress dialog.
2693 </para>
2694 </remarks>
2695 </member>
2696 <member name="P:Ookii.Dialogs.Wpf.ProgressDialog.Description">
2697 <summary>
2698 Gets or sets additional details about the operation being carried out.
2699 </summary>
2700 <value>
2701 Additional details about the operation being carried out. The default value is an empty string.
2702 </value>
2703 <remarks>
2704 This text is used to provide additional details beyond the <see cref="P:Ookii.Dialogs.Wpf.ProgressDialog.Text"/> property.
2705 </remarks>
2706 <remarks>
2707 <para>
2708 This property can be changed while the dialog is running, but may only be changed from the thread which
2709 created the progress dialog. The recommended method to change this value while the dialog is running
2710 is to use the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)"/> method.
2711 </para>
2712 </remarks>
2713 </member>
2714 <member name="P:Ookii.Dialogs.Wpf.ProgressDialog.UseCompactPathsForDescription">
2715 <summary>
2716 Gets or sets a value that indicates whether path strings in the <see cref="P:Ookii.Dialogs.Wpf.ProgressDialog.Description"/> property should be compacted if
2717 they are too large to fit on one line.
2718 </summary>
2719 <value>
2720 <see langword="true"/> to compact path strings if they are too large to fit on one line; otherwise,
2721 <see langword="false"/>. The default value is <see langword="false"/>.
2722 </value>
2723 <remarks>
2724 <note>
2725 This property requires Windows Vista or later. On older versions of Windows, it has no effect.
2726 </note>
2727 <para>
2728 This property can be changed while the dialog is running, but may only be changed from the thread which
2729 created the progress dialog.
2730 </para>
2731 </remarks>
2732 </member>
2733 <member name="P:Ookii.Dialogs.Wpf.ProgressDialog.CancellationText">
2734 <summary>
2735 Gets or sets the text that will be shown after the Cancel button is pressed.
2736 </summary>
2737 <value>
2738 The text that will be shown after the Cancel button is pressed.
2739 </value>
2740 <remarks>
2741 <para>
2742 This property must be set before <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.Show"/> is called. Changing property has
2743 no effect while the dialog is being displayed.
2744 </para>
2745 </remarks>
2746 </member>
2747 <member name="P:Ookii.Dialogs.Wpf.ProgressDialog.ShowTimeRemaining">
2748 <summary>
2749 Gets or sets a value that indicates whether an estimate of the remaining time will be shown.
2750 </summary>
2751 <value>
2752 <see langword="true"/> if an estimate of remaining time will be shown; otherwise, <see langword="false"/>. The
2753 default value is <see langword="false"/>.
2754 </value>
2755 <remarks>
2756 <para>
2757 This property must be set before <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.Show"/> is called. Changing property has
2758 no effect while the dialog is being displayed.
2759 </para>
2760 </remarks>
2761 </member>
2762 <member name="P:Ookii.Dialogs.Wpf.ProgressDialog.ShowCancelButton">
2763 <summary>
2764 Gets or sets a value that indicates whether the dialog has a cancel button.
2765 </summary>
2766 <value>
2767 <see langword="true"/> if the dialog has a cancel button; otherwise, <see langword="false"/>. The default
2768 value is <see langword="true"/>.
2769 </value>
2770 <remarks>
2771 <note>
2772 This property requires Windows Vista or later; on older versions of Windows, the cancel button will always
2773 be displayed.
2774 </note>
2775 <para>
2776 The event handler for the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event must periodically check the value of the
2777 <see cref="P:Ookii.Dialogs.Wpf.ProgressDialog.CancellationPending"/> property to see if the operation has been cancelled if this
2778 property is <see langword="true"/>.
2779 </para>
2780 <para>
2781 Setting this property to <see langword="false"/> is not recommended unless absolutely necessary.
2782 </para>
2783 </remarks>
2784 </member>
2785 <member name="P:Ookii.Dialogs.Wpf.ProgressDialog.MinimizeBox">
2786 <summary>
2787 Gets or sets a value that indicates whether the progress dialog has a minimize button.
2788 </summary>
2789 <value>
2790 <see langword="true"/> if the dialog has a minimize button; otherwise, <see langword="false"/>. The default
2791 value is <see langword="true"/>.
2792 </value>
2793 <remarks>
2794 <note>
2795 This property has no effect on modal dialogs (which do not have a minimize button). It only applies
2796 to modeless dialogs shown by using the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.Show"/> method.
2797 </note>
2798 <para>
2799 This property must be set before <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.Show"/> is called. Changing property has
2800 no effect while the dialog is being displayed.
2801 </para>
2802 </remarks>
2803 </member>
2804 <member name="P:Ookii.Dialogs.Wpf.ProgressDialog.CancellationPending">
2805 <summary>
2806 Gets a value indicating whether the user has requested cancellation of the operation.
2807 </summary>
2808 <value>
2809 <see langword="true"/> if the user has cancelled the progress dialog; otherwise, <see langword="false"/>. The default is <see langword="false"/>.
2810 </value>
2811 <remarks>
2812 The event handler for the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event must periodically check this property and abort the operation
2813 if it returns <see langword="true"/>.
2814 </remarks>
2815 </member>
2816 <member name="P:Ookii.Dialogs.Wpf.ProgressDialog.Animation">
2817 <summary>
2818 Gets or sets the animation to show on the progress dialog.
2819 </summary>
2820 <value>
2821 An instance of <see cref="T:Ookii.Dialogs.Wpf.AnimationResource"/> which specifies the animation to show, or <see langword="null"/>
2822 to show no animation. The default value is <see langword="null"/>.
2823 </value>
2824 <remarks>
2825 <para>
2826 This property has no effect on Windows Vista or later. On Windows XP, this property will default to
2827 a flying papers animation.
2828 </para>
2829 <para>
2830 This property must be set before <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.Show"/> is called. Changing property has
2831 no effect while the dialog is being displayed.
2832 </para>
2833 </remarks>
2834 </member>
2835 <member name="P:Ookii.Dialogs.Wpf.ProgressDialog.ProgressBarStyle">
2836 <summary>
2837 Gets or sets a value that indicates whether a regular or marquee style progress bar should be used.
2838 </summary>
2839 <value>
2840 One of the values of <see cref="T:Ookii.Dialogs.Wpf.ProgressBarStyle"/>.
2841 The default value is <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.ProgressBar"/>.
2842 </value>
2843 <remarks>
2844 <note>
2845 Operating systems older than Windows Vista do not support marquee progress bars on the progress dialog. On those operating systems, the
2846 progress bar will be hidden completely if this property is <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.MarqueeProgressBar"/>.
2847 </note>
2848 <para>
2849 When this property is set to <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.ProgressBar"/>, use the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ReportProgress(System.Int32)"/> method to set
2850 the value of the progress bar. When this property is set to <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.MarqueeProgressBar"/>
2851 you can still use the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)"/> method to update the text of the dialog,
2852 but the percentage will be ignored.
2853 </para>
2854 <para>
2855 This property must be set before <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.Show"/> is called. Changing property has
2856 no effect while the dialog is being displayed.
2857 </para>
2858 </remarks>
2859 </member>
2860 <member name="P:Ookii.Dialogs.Wpf.ProgressDialog.IsBusy">
2861 <summary>
2862 Gets a value that indicates whether the <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> is running an asynchronous operation.
2863 </summary>
2864 <value>
2865 <see langword="true"/> if the <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> is running an asynchronous operation;
2866 otherwise, <see langword="false"/>.
2867 </value>
2868 </member>
2869 <member name="T:Ookii.Dialogs.Wpf.TaskDialogItemClickedEventArgs">
2870 <summary>
2871 Provides data for the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.ButtonClicked"/> event.
2872 </summary>
2873 <threadsafety instance="false" static="true"/>
2874 </member>
2875 <member name="M:Ookii.Dialogs.Wpf.TaskDialogItemClickedEventArgs.#ctor(Ookii.Dialogs.Wpf.TaskDialogItem)">
2876 <summary>
2877 Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItemClickedEventArgs"/> class with the specified item.
2878 </summary>
2879 <param name="item">The <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> that was clicked.</param>
2880 </member>
2881 <member name="P:Ookii.Dialogs.Wpf.TaskDialogItemClickedEventArgs.Item">
2882 <summary>
2883 Gets the item that was clicked.
2884 </summary>
2885 <value>
2886 The <see cref="T:Ookii.Dialogs.Wpf.TaskDialogItem"/> that was clicked.
2887 </value>
2888 </member>
2889 <member name="T:Ookii.Dialogs.Wpf.ButtonType">
2890 <summary>
2891 Represents the type of a task dialog button.
2892 </summary>
2893 </member>
2894 <member name="F:Ookii.Dialogs.Wpf.ButtonType.Custom">
2895 <summary>
2896 The button is a custom button.
2897 </summary>
2898 </member>
2899 <member name="F:Ookii.Dialogs.Wpf.ButtonType.Ok">
2900 <summary>
2901 The button is the common OK button.
2902 </summary>
2903 </member>
2904 <member name="F:Ookii.Dialogs.Wpf.ButtonType.Yes">
2905 <summary>
2906 The button is the common Yes button.
2907 </summary>
2908 </member>
2909 <member name="F:Ookii.Dialogs.Wpf.ButtonType.No">
2910 <summary>
2911 The button is the common No button.
2912 </summary>
2913 </member>
2914 <member name="F:Ookii.Dialogs.Wpf.ButtonType.Cancel">
2915 <summary>
2916 The button is the common Cancel button.
2917 </summary>
2918 </member>
2919 <member name="F:Ookii.Dialogs.Wpf.ButtonType.Retry">
2920 <summary>
2921 The button is the common Retry button.
2922 </summary>
2923 </member>
2924 <member name="F:Ookii.Dialogs.Wpf.ButtonType.Close">
2925 <summary>
2926 The button is the common Close button.
2927 </summary>
2928 </member>
2929 <member name="T:Ookii.Dialogs.Wpf.ProgressBarState">
2930 <summary>
2931 Represents the state of the progress bar on the task dialog.
2932 </summary>
2933 </member>
2934 <member name="F:Ookii.Dialogs.Wpf.ProgressBarState.Normal">
2935 <summary>
2936 Normal state.
2937 </summary>
2938 </member>
2939 <member name="F:Ookii.Dialogs.Wpf.ProgressBarState.Error">
2940 <summary>
2941 Error state
2942 </summary>
2943 </member>
2944 <member name="F:Ookii.Dialogs.Wpf.ProgressBarState.Paused">
2945 <summary>
2946 Paused state
2947 </summary>
2948 </member>
2949 <member name="T:Ookii.Dialogs.Wpf.HyperlinkClickedEventArgs">
2950 <summary>
2951 Class that provides data for the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.HyperlinkClicked"/> event.
2952 </summary>
2953 <threadsafety instance="false" static="true"/>
2954 </member>
2955 <member name="M:Ookii.Dialogs.Wpf.HyperlinkClickedEventArgs.#ctor(System.String)">
2956 <summary>
2957 Creates a new instance of the <see cref="T:Ookii.Dialogs.Wpf.HyperlinkClickedEventArgs"/> class with the specified URL.
2958 </summary>
2959 <param name="href">The URL of the hyperlink.</param>
2960 </member>
2961 <member name="P:Ookii.Dialogs.Wpf.HyperlinkClickedEventArgs.Href">
2962 <summary>
2963 Gets the URL of the hyperlink that was clicked.
2964 </summary>
2965 <value>
2966 The value of the href attribute of the hyperlink.
2967 </value>
2968 </member>
2969 </members>
2970 </doc>