-
Notifications
You must be signed in to change notification settings - Fork 0
/
Ookii.Dialogs.Wpf.xml
2970 lines (2970 loc) · 165 KB
/
Ookii.Dialogs.Wpf.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>Ookii.Dialogs.Wpf</name>
</assembly>
<members>
<member name="T:Ookii.Dialogs.Wpf.AnimationResource">
<summary>
Represents an animation for the <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> loaded from a Win32 resource.
</summary>
<threadsafety instance="false" static="true" />
</member>
<member name="M:Ookii.Dialogs.Wpf.AnimationResource.#ctor(System.String,System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.AnimationResource"/> class.
</summary>
<param name="resourceFile">The file containing the animation resource.</param>
<param name="resourceId">The resource ID of the animation resource.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="resourceFile"/> is <see langword="null"/>.</exception>
</member>
<member name="P:Ookii.Dialogs.Wpf.AnimationResource.ResourceFile">
<summary>
Gets the name of the file containing the animation resource.
</summary>
<value>
The name of the file containing the animation resource. This is typically a DLL or EXE file.
</value>
</member>
<member name="P:Ookii.Dialogs.Wpf.AnimationResource.ResourceId">
<summary>
Gets the ID of the animation resource.
</summary>
<value>
The ID of the animation resource.
</value>
</member>
<member name="M:Ookii.Dialogs.Wpf.AnimationResource.GetShellAnimation(Ookii.Dialogs.Wpf.ShellAnimation)">
<summary>
Gets a default animation from shell32.dll.
</summary>
<param name="animation">The animation to get.</param>
<returns>An instance of the <see cref="T:Ookii.Dialogs.Wpf.AnimationResource"/> class representing the specified animation.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="animation"/> parameter was not a value defined in the
<see cref="T:Ookii.Dialogs.Wpf.ShellAnimation"/> enumeration.</exception>
</member>
<member name="T:Ookii.Dialogs.Wpf.ButtonType">
<summary>
Represents the type of a task dialog button.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.ButtonType.Custom">
<summary>
The button is a custom button.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.ButtonType.Ok">
<summary>
The button is the common OK button.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.ButtonType.Yes">
<summary>
The button is the common Yes button.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.ButtonType.No">
<summary>
The button is the common No button.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.ButtonType.Cancel">
<summary>
The button is the common Cancel button.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.ButtonType.Retry">
<summary>
The button is the common Retry button.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.ButtonType.Close">
<summary>
The button is the common Close button.
</summary>
</member>
<member name="T:Ookii.Dialogs.Wpf.CredentialDialog">
<summary>
Represents a dialog box that allows the user to enter generic credentials.
</summary>
<remarks>
<para>
This class is meant for generic credentials; it does not provide access to all the functionality
of the Windows CredUI API. Features such as Windows domain credentials or alternative security
providers (e.g. smartcards or biometric devices) are not supported.
</para>
<para>
The <see cref="T:Ookii.Dialogs.Wpf.CredentialDialog"/> class provides methods for storing and retrieving credentials,
and also manages automatic persistence of credentials by using the "Save password" checkbox on
the credentials dialog. To specify the target for which the credentials should be saved, set the
<see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/> property.
</para>
<note>
This class requires Windows XP or later.
</note>
</remarks>
<threadsafety instance="false" static="true" />
</member>
<member name="E:Ookii.Dialogs.Wpf.CredentialDialog.UserNameChanged">
<summary>
Event raised when the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.UserName"/> property changes.
</summary>
</member>
<member name="E:Ookii.Dialogs.Wpf.CredentialDialog.PasswordChanged">
<summary>
Event raised when the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Password"/> property changes.
</summary>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialDialog.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialDialog"/> class.
</summary>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialDialog.#ctor(System.ComponentModel.IContainer)">
<summary>
Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialDialog"/> class with the specified container.
</summary>
<param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the component to.</param>
</member>
<member name="P:Ookii.Dialogs.Wpf.CredentialDialog.UseApplicationInstanceCredentialCache">
<summary>
Gets or sets whether to use the application instance credential cache.
</summary>
<value>
<see langword="true" /> when credentials are saved in the application instance cache; <see langref="false" /> if they are not.
The default value is <see langword="false" />.
</value>
<remarks>
<para>
The application instance credential cache stores credentials in memory while an application is running. When the
application exits, this cache is not persisted.
</para>
<para>
When the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.UseApplicationInstanceCredentialCache"/> property is set to <see langword="true"/>, credentials that
are confirmed with <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.ConfirmCredentials(System.Boolean)"/> when the user checked the "save password" option will be stored
in the application instance cache as well as the operating system credential store.
</para>
<para>
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
the application instance cache, the dialog will not be shown and the cached credentials are returned, even if
<see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowUIForSavedCredentials"/> is <see langword="true"/>.
</para>
<para>
The application instance credential cache allows you to prevent prompting the user again for the lifetime of the
application if the "save password" checkbox was checked, but when the application is restarted you can prompt again
(initializing the dialog with the saved credentials). To get this behaviour, the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowUIForSavedCredentials"/>
property must be set to <see langword="true"/>.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.CredentialDialog.IsSaveChecked">
<summary>
Gets or sets whether the "save password" checkbox is checked.
</summary>
<value>
<see langword="true" /> if the "save password" is checked; otherwise, <see langword="false" />.
The default value is <see langword="false" />.
</value>
<remarks>
The value of this property is only valid if the dialog box is displayed with a save checkbox.
Set this property before showing the dialog to determine the initial checked value of the save checkbox.
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.CredentialDialog.Password">
<summary>
Gets the password the user entered in the dialog.
</summary>
<value>
The password entered in the password field of the credentials dialog.
</value>
</member>
<member name="P:Ookii.Dialogs.Wpf.CredentialDialog.Credentials">
<summary>
Gets the user-specified user name and password in a <see cref="T:System.Net.NetworkCredential"/> object.
</summary>
<value>
A <see cref="T:System.Net.NetworkCredential"/> instance containing the user name and password specified on the dialog.
</value>
</member>
<member name="P:Ookii.Dialogs.Wpf.CredentialDialog.UserName">
<summary>
Gets the user name the user entered in the dialog.
</summary>
<value>
The user name entered in the user name field of the credentials dialog.
The default value is an empty string ("").
</value>
</member>
<member name="P:Ookii.Dialogs.Wpf.CredentialDialog.Target">
<summary>
Gets or sets the target for the credentials, typically a server name.
</summary>
<value>
The target for the credentials. The default value is an empty string ("").
</value>
<remarks>
Credentials are stored on a per user, not on a per application basis. To ensure that credentials stored by different
applications do not conflict, you should prefix the target with an application-specific identifer, e.g.
"Company_Application_target".
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.CredentialDialog.WindowTitle">
<summary>
Gets or sets the title of the credentials dialog.
</summary>
<value>
The title of the credentials dialog. The default value is an empty string ("").
</value>
<remarks>
<para>
This property is not used on Windows Vista and newer versions of windows; the window title will always be "Windows Security"
in that case.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction">
<summary>
Gets or sets a brief message to display in the dialog box.
</summary>
<value>
A brief message that will be displayed in the dialog box. The default value is an empty string ("").
</value>
<remarks>
<para>
On Windows Vista and newer versions of Windows, this text is displayed using a different style to set it apart
from the other text. In the default style, this text is a slightly larger and colored blue. The style is identical
to the main instruction of a task dialog.
</para>
<para>
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"/>
property.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.CredentialDialog.Content">
<summary>
Gets or sets additional text to display in the dialog.
</summary>
<value>
Additional text to display in the dialog. The default value is an empty string ("").
</value>
<remarks>
<para>
On Windows Vista and newer versions of Windows, this text is placed below the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction"/> text.
</para>
<para>
On Windows XP, how and if this text is displayed depends on the value of the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.DownlevelTextMode"/>
property.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.CredentialDialog.DownlevelTextMode">
<summary>
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
is displayed on Windows XP.
</summary>
<value>
One of the values of the <see cref="T:Ookii.Dialogs.Wpf.DownlevelTextMode"/> enumeration. The default value is
<see cref="F:Ookii.Dialogs.Wpf.DownlevelTextMode.MainInstructionAndContent"/>.
</value>
<remarks>
<para>
Windows XP does not support the distinct visual style of the main instruction, so there is no visual difference between the
text of the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Content"/> properties. Depending
on your requirements, you may wish to hide either the main instruction or the content text.
</para>
<para>
This property has no effect on Windows Vista and newer versions of Windows.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowSaveCheckBox">
<summary>
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
the credentials or not.
</summary>
<value>
<see langword="true" /> when the "save password" checkbox is shown on the credentials dialog; otherwise, <see langword="false"/>.
The default value is <see langword="false" />.
</value>
<remarks>
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
credentials. When this property is set to <see langword="false" />, the credentials will never be saved, and you should not call
the <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.ConfirmCredentials(System.Boolean)"/> method.
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowUIForSavedCredentials">
<summary>
Gets or sets a value that indicates whether the dialog should be displayed even when saved credentials exist for the
specified target.
</summary>
<value>
<see langword="true" /> if the dialog is displayed even when saved credentials exist; otherwise, <see langword="false" />.
The default value is <see langword="false" />.
</value>
<remarks>
<para>
This property applies only when the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowSaveCheckBox"/> property is <see langword="true" />.
</para>
<para>
Note that even if this property is <see langword="true" />, if the proper credentials exist in the
application instance credentials cache the dialog will not be displayed.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.CredentialDialog.IsStoredCredential">
<summary>
Gets a value that indicates whether the current credentials were retrieved from a credential store.
</summary>
<value>
<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"/>,
and <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Credentials"/> properties were retrieved from either the application instance credential cache
or the operating system's credential store; otherwise, <see langword="false"/>.
</value>
<remarks>
<para>
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"/>.
If the dialog was shown, this property will be <see langword="false"/>; if the credentials were retrieved from the
application instance cache or the credential store and the dialog was not shown it will be <see langword="true"/>.
</para>
<para>
If the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.ShowUIForSavedCredentials"/> property is set to <see langword="true"/>, and the dialog is shown
but populated with stored credentials, this property will still return <see langword="false"/>.
</para>
</remarks>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialDialog.ShowDialog">
<summary>
Shows the credentials dialog as a modal dialog.
</summary>
<returns><see langword="true" /> if the user clicked OK; otherwise, <see langword="false" />.</returns>
<remarks>
<para>
The credentials dialog will not be shown if one of the following conditions holds:
</para>
<list type="bullet">
<item>
<description>
<see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.UseApplicationInstanceCredentialCache"/> is <see langword="true"/> and the application instance
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"/>
is <see langword="true"/>.
</description>
</item>
<item>
<description>
<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
for the current user contains credentials for the specified <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/>.
</description>
</item>
</list>
<para>
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
be set to the saved credentials and this function returns immediately, returning <see langword="true" />.
</para>
<para>
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)"/>
after validating if the provided credentials are correct.
</para>
</remarks>
<exception cref="T:Ookii.Dialogs.Wpf.CredentialException">An error occurred while showing the credentials dialog.</exception>
<exception cref="T:System.InvalidOperationException"><see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/> is an empty string ("").</exception>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialDialog.ShowDialog(System.Windows.Window)">
<summary>
Shows the credentials dialog as a modal dialog with the specified owner.
</summary>
<param name="owner">The <see cref="T:System.Windows.Window"/> that owns the credentials dialog.</param>
<returns><see langword="true" /> if the user clicked OK; otherwise, <see langword="false" />.</returns>
<remarks>
<para>
The credentials dialog will not be shown if one of the following conditions holds:
</para>
<list type="bullet">
<item>
<description>
<see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.UseApplicationInstanceCredentialCache"/> is <see langword="true"/> and the application instance
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"/>
is <see langword="true"/>.
</description>
</item>
<item>
<description>
<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
for the current user contains credentials for the specified <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/>.
</description>
</item>
</list>
<para>
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
be set to the saved credentials and this function returns immediately, returning <see langword="true" />.
</para>
<para>
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)"/>
after validating if the provided credentials are correct.
</para>
</remarks>
<exception cref="T:Ookii.Dialogs.Wpf.CredentialException">An error occurred while showing the credentials dialog.</exception>
<exception cref="T:System.InvalidOperationException"><see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/> is an empty string ("").</exception>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialDialog.ConfirmCredentials(System.Boolean)">
<summary>
Confirms the validity of the credential provided by the user.
</summary>
<param name="confirm"><see langword="true" /> if the credentials that were specified on the dialog are valid; otherwise, <see langword="false" />.</param>
<remarks>
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" />.
Only when this function is called with <paramref name="confirm"/> set to <see langword="true" /> will the credentials be
saved in the credentials store and/or the application instance credential cache.
</remarks>
<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" />
at the call, or the value of <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Target"/> or <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.IsSaveChecked"/>
was changed after the call.</exception>
<exception cref="T:Ookii.Dialogs.Wpf.CredentialException">There was an error saving the credentials.</exception>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialDialog.StoreCredential(System.String,System.Net.NetworkCredential)">
<summary>
Stores the specified credentials in the operating system's credential store for the currently logged on user.
</summary>
<param name="target">The target name for the credentials.</param>
<param name="credential">The credentials to store.</param>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="target"/> is <see langword="null" />.
</para>
<para>
-or-
</para>
<para>
<paramref name="credential"/> is <see langword="null" />.
</para>
</exception>
<exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>
<exception cref="T:Ookii.Dialogs.Wpf.CredentialException">An error occurred storing the credentials.</exception>
<remarks>
<note>
The <see cref="P:System.Net.NetworkCredential.Domain"/> property is ignored and will not be stored, even if it is
not <see langword="null" />.
</note>
<para>
If the credential manager already contains credentials for the specified <paramref name="target"/>, they
will be overwritten; this can even overwrite credentials that were stored by another application. Therefore
it is strongly recommended that you prefix the target name to ensure uniqueness, e.g. using the
form "Company_ApplicationName_www.example.com".
</para>
</remarks>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialDialog.RetrieveCredential(System.String)">
<summary>
Retrieves credentials for the specified target from the operating system's credential store for the current user.
</summary>
<param name="target">The target name for the credentials.</param>
<returns>The credentials if they were found; otherwise, <see langword="null" />.</returns>
<remarks>
<para>
If the requested credential was not originally stored using the <see cref="T:Ookii.Dialogs.Wpf.CredentialDialog"/> class (but e.g. by
another application), the password may not be decoded correctly.
</para>
<para>
This function does not check the application instance credential cache for the credentials; for that you can use
the <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.RetrieveCredentialFromApplicationInstanceCache(System.String)"/> function.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="target"/> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>
<exception cref="T:Ookii.Dialogs.Wpf.CredentialException">An error occurred retrieving the credentials.</exception>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialDialog.RetrieveCredentialFromApplicationInstanceCache(System.String)">
<summary>
Tries to get the credentials for the specified target from the application instance credential cache.
</summary>
<param name="target">The target for the credentials, typically a server name.</param>
<returns>The credentials that were found in the application instance cache; otherwise, <see langword="null" />.</returns>
<remarks>
<para>
This function will only check the the application instance credential cache; the operating system's credential store
is not checked. To retrieve credentials from the operating system's store, use <see cref="M:Ookii.Dialogs.Wpf.CredentialDialog.RetrieveCredential(System.String)"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="target"/> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialDialog.DeleteCredential(System.String)">
<summary>
Deletes the credentials for the specified target.
</summary>
<param name="target">The name of the target for which to delete the credentials.</param>
<returns><see langword="true"/> if the credential was deleted from either the application instance cache or
the operating system's store; <see langword="false"/> if no credentials for the specified target could be found
in either store.</returns>
<remarks>
<para>
The credentials for the specified target will be removed from the application instance credential cache
and the operating system's credential store.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="target"/> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>
<exception cref="T:Ookii.Dialogs.Wpf.CredentialException">An error occurred deleting the credentials from the operating system's credential store.</exception>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialDialog.OnUserNameChanged(System.EventArgs)">
<summary>
Raises the <see cref="E:Ookii.Dialogs.Wpf.CredentialDialog.UserNameChanged"/> event.
</summary>
<param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialDialog.OnPasswordChanged(System.EventArgs)">
<summary>
Raises the <see cref="E:Ookii.Dialogs.Wpf.CredentialDialog.PasswordChanged"/> event.
</summary>
<param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>
</member>
<member name="F:Ookii.Dialogs.Wpf.CredentialDialog.components">
<summary>
Required designer variable.
</summary>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialDialog.Dispose(System.Boolean)">
<summary>
Clean up any resources being used.
</summary>
<param name="disposing"><see langword="true"/> if managed resources should be disposed; otherwise, <see langword="false"/>.</param>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialDialog.InitializeComponent">
<summary>
Required method for Designer support - do not modify
the contents of this method with the code editor.
</summary>
</member>
<member name="T:Ookii.Dialogs.Wpf.CredentialException">
<summary>
The exception that is thrown when an error occurs getting credentials.
</summary>
<threadsafety instance="false" static="true" />
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialException" /> class.
</summary>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialException.#ctor(System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialException" /> class with the specified error.
</summary>
<param name="error">The Win32 error code associated with this exception.</param>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialException" /> class with a specified error message.
</summary>
<param name="message">The message that describes the error.</param>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialException.#ctor(System.Int32,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialException" /> class with the specified error and the specified detailed description.
</summary>
<param name="error">The Win32 error code associated with this exception.</param>
<param name="message">A detailed description of the error.</param>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialException.#ctor(System.String,System.Exception)">
<summary>
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.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">A reference to the inner exception that is the cause of the current exception.</param>
</member>
<member name="M:Ookii.Dialogs.Wpf.CredentialException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.CredentialException" /> class with serialized data.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
</member>
<member name="T:Ookii.Dialogs.Wpf.DownlevelTextMode">
<summary>
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"/>
properties is displayed on a credential dialog in Windows XP.
</summary>
<remarks>
<para>
Windows XP does not support the distinct visual style of the main instruction, so there is no visual difference between the
text of the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Content"/> properties. Depending
on the scenario, you may wish to hide either the main instruction or the content text.
</para>
</remarks>
</member>
<member name="F:Ookii.Dialogs.Wpf.DownlevelTextMode.MainInstructionAndContent">
<summary>
The text of the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Content"/> properties is
concatenated together, separated by an empty line.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.DownlevelTextMode.MainInstructionOnly">
<summary>
Only the text of the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.MainInstruction"/> property is shown.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.DownlevelTextMode.ContentOnly">
<summary>
Only the text of the <see cref="P:Ookii.Dialogs.Wpf.CredentialDialog.Content"/> property is shown.
</summary>
</member>
<member name="T:Ookii.Dialogs.Wpf.ExpandButtonClickedEventArgs">
<summary>
Provides data for the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.ExpandButtonClicked"/> event.
</summary>
<threadsafety instance="false" static="true" />
</member>
<member name="M:Ookii.Dialogs.Wpf.ExpandButtonClickedEventArgs.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.ExpandButtonClickedEventArgs"/> class with the specified expanded state.
</summary>
<param name="expanded"><see langword="true" /> if the the expanded content on the dialog is shown; otherwise, <see langword="false" />.</param>
</member>
<member name="P:Ookii.Dialogs.Wpf.ExpandButtonClickedEventArgs.Expanded">
<summary>
Gets a value that indicates if the expanded content on the dialog is shown.
</summary>
<value><see langword="true" /> if the expanded content on the dialog is shown; otherwise, <see langword="false" />.</value>
</member>
<member name="T:Ookii.Dialogs.Wpf.HyperlinkClickedEventArgs">
<summary>
Class that provides data for the <see cref="E:Ookii.Dialogs.Wpf.TaskDialog.HyperlinkClicked"/> event.
</summary>
<threadsafety instance="false" static="true" />
</member>
<member name="M:Ookii.Dialogs.Wpf.HyperlinkClickedEventArgs.#ctor(System.String)">
<summary>
Creates a new instance of the <see cref="T:Ookii.Dialogs.Wpf.HyperlinkClickedEventArgs"/> class with the specified URL.
</summary>
<param name="href">The URL of the hyperlink.</param>
</member>
<member name="P:Ookii.Dialogs.Wpf.HyperlinkClickedEventArgs.Href">
<summary>
Gets the URL of the hyperlink that was clicked.
</summary>
<value>
The value of the href attribute of the hyperlink.
</value>
</member>
<member name="T:Ookii.Dialogs.Wpf.Interop.IMalloc">
<summary>
C# definition of the IMalloc interface.
</summary>
</member>
<member name="M:Ookii.Dialogs.Wpf.Interop.IMalloc.Alloc(System.UInt32)">
<summary>
Allocate a block of memory
</summary>
<param name="cb">Size, in bytes, of the memory block to be allocated.</param>
<returns>a pointer to the allocated memory block.</returns>
</member>
<member name="M:Ookii.Dialogs.Wpf.Interop.IMalloc.Realloc(System.IntPtr,System.UInt32)">
<summary>
Changes the size of a previously allocated memory block.
</summary>
<param name="pv">Pointer to the memory block to be reallocated</param>
<param name="cb">Size of the memory block, in bytes, to be reallocated.</param>
<returns>reallocated memory block</returns>
</member>
<member name="M:Ookii.Dialogs.Wpf.Interop.IMalloc.Free(System.IntPtr)">
<summary>
Free a previously allocated block of memory.
</summary>
<param name="pv">Pointer to the memory block to be freed.</param>
</member>
<member name="M:Ookii.Dialogs.Wpf.Interop.IMalloc.GetSize(System.IntPtr)">
<summary>
This method returns the size, in bytes, of a memory block previously allocated with IMalloc::Alloc or IMalloc::Realloc.
</summary>
<param name="pv">Pointer to the memory block for which the size is requested</param>
<returns>The size of the allocated memory block in bytes.</returns>
</member>
<member name="M:Ookii.Dialogs.Wpf.Interop.IMalloc.DidAlloc(System.IntPtr)">
<summary>
This method determines whether this allocator was used to allocate the specified block of memory.
</summary>
<param name="pv">Pointer to the memory block</param>
<returns>
1 - allocated
0 - not allocated by this IMalloc Instance.
-1 if DidAlloc is unable to determine whether or not it allocated the memory block.
</returns>
</member>
<member name="M:Ookii.Dialogs.Wpf.Interop.IMalloc.HeapMinimize">
<summary>
Minimizes the heap by releasing unused memory to the operating system.
</summary>
</member>
<member name="T:Ookii.Dialogs.Wpf.ProgressBarState">
<summary>
Represents the state of the progress bar on the task dialog.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.ProgressBarState.Normal">
<summary>
Normal state.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.ProgressBarState.Error">
<summary>
Error state
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.ProgressBarState.Paused">
<summary>
Paused state
</summary>
</member>
<member name="T:Ookii.Dialogs.Wpf.ProgressBarStyle">
<summary>
Indicates the type of progress on a task dialog.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.ProgressBarStyle.None">
<summary>
No progress bar is displayed on the dialog.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.ProgressBarStyle.ProgressBar">
<summary>
A regular progress bar is displayed on the dialog.
</summary>
</member>
<member name="F:Ookii.Dialogs.Wpf.ProgressBarStyle.MarqueeProgressBar">
<summary>
A marquee progress bar is displayed on the dialog. Use this value for operations
that cannot report concrete progress information.
</summary>
</member>
<member name="T:Ookii.Dialogs.Wpf.ProgressDialog">
<summary>
Represents a dialog that can be used to report progress to the user.
</summary>
<remarks>
<para>
This class provides a wrapper for the native Windows IProgressDialog API.
</para>
<para>
The <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> class requires Windows 2000, Windows Me, or newer versions of Windows.
</para>
</remarks>
<threadsafety static="true" instance="false" />
</member>
<member name="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork">
<summary>
Event raised when the dialog is displayed.
</summary>
<remarks>
Use this event to perform the operation that the dialog is showing the progress for.
This event will be raised on a different thread than the UI thread.
</remarks>
</member>
<member name="E:Ookii.Dialogs.Wpf.ProgressDialog.RunWorkerCompleted">
<summary>
Event raised when the operation completes.
</summary>
</member>
<member name="E:Ookii.Dialogs.Wpf.ProgressDialog.ProgressChanged">
<summary>
Event raised when <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ReportProgress(System.Int32,System.String,System.String,System.Object)"/> is called.
</summary>
</member>
<member name="M:Ookii.Dialogs.Wpf.ProgressDialog.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> class.
</summary>
</member>
<member name="M:Ookii.Dialogs.Wpf.ProgressDialog.#ctor(System.ComponentModel.IContainer)">
<summary>
Initializes a new instance of the <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> class, adding it to the specified container.
</summary>
<param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to which the component should be added.</param>
</member>
<member name="P:Ookii.Dialogs.Wpf.ProgressDialog.WindowTitle">
<summary>
Gets or sets the text in the progress dialog's title bar.
</summary>
<value>
The text in the progress dialog's title bar. The default value is an empty string.
</value>
<remarks>
<para>
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
no effect while the dialog is being displayed.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.ProgressDialog.Text">
<summary>
Gets or sets a short description of the operation being carried out.
</summary>
<value>
A short description of the operation being carried. The default value is an empty string.
</value>
<remarks>
<para>
This is the primary message to the user.
</para>
<para>
This property can be changed while the dialog is running, but may only be changed from the thread which
created the progress dialog. The recommended method to change this value while the dialog is running
is to use the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)"/> method.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.ProgressDialog.UseCompactPathsForText">
<summary>
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
they are too large to fit on one line.
</summary>
<value>
<see langword="true"/> to compact path strings if they are too large to fit on one line; otherwise,
<see langword="false"/>. The default value is <see langword="false"/>.
</value>
<remarks>
<note>
This property requires Windows Vista or later. On older versions of Windows, it has no effect.
</note>
<para>
This property can be changed while the dialog is running, but may only be changed from the thread which
created the progress dialog.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.ProgressDialog.Description">
<summary>
Gets or sets additional details about the operation being carried out.
</summary>
<value>
Additional details about the operation being carried out. The default value is an empty string.
</value>
<remarks>
This text is used to provide additional details beyond the <see cref="P:Ookii.Dialogs.Wpf.ProgressDialog.Text"/> property.
</remarks>
<remarks>
<para>
This property can be changed while the dialog is running, but may only be changed from the thread which
created the progress dialog. The recommended method to change this value while the dialog is running
is to use the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)"/> method.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.ProgressDialog.UseCompactPathsForDescription">
<summary>
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
they are too large to fit on one line.
</summary>
<value>
<see langword="true"/> to compact path strings if they are too large to fit on one line; otherwise,
<see langword="false"/>. The default value is <see langword="false"/>.
</value>
<remarks>
<note>
This property requires Windows Vista or later. On older versions of Windows, it has no effect.
</note>
<para>
This property can be changed while the dialog is running, but may only be changed from the thread which
created the progress dialog.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.ProgressDialog.CancellationText">
<summary>
Gets or sets the text that will be shown after the Cancel button is pressed.
</summary>
<value>
The text that will be shown after the Cancel button is pressed.
</value>
<remarks>
<para>
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
no effect while the dialog is being displayed.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.ProgressDialog.ShowTimeRemaining">
<summary>
Gets or sets a value that indicates whether an estimate of the remaining time will be shown.
</summary>
<value>
<see langword="true"/> if an estimate of remaining time will be shown; otherwise, <see langword="false"/>. The
default value is <see langword="false"/>.
</value>
<remarks>
<para>
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
no effect while the dialog is being displayed.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.ProgressDialog.ShowCancelButton">
<summary>
Gets or sets a value that indicates whether the dialog has a cancel button.
</summary>
<value>
<see langword="true"/> if the dialog has a cancel button; otherwise, <see langword="false"/>. The default
value is <see langword="true"/>.
</value>
<remarks>
<note>
This property requires Windows Vista or later; on older versions of Windows, the cancel button will always
be displayed.
</note>
<para>
The event handler for the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event must periodically check the value of the
<see cref="P:Ookii.Dialogs.Wpf.ProgressDialog.CancellationPending"/> property to see if the operation has been cancelled if this
property is <see langword="true"/>.
</para>
<para>
Setting this property to <see langword="false"/> is not recommended unless absolutely necessary.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.ProgressDialog.MinimizeBox">
<summary>
Gets or sets a value that indicates whether the progress dialog has a minimize button.
</summary>
<value>
<see langword="true"/> if the dialog has a minimize button; otherwise, <see langword="false"/>. The default
value is <see langword="true"/>.
</value>
<remarks>
<note>
This property has no effect on modal dialogs (which do not have a minimize button). It only applies
to modeless dialogs shown by using the <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.Show"/> method.
</note>
<para>
This property must be set before <see cref="M:Ookii.Dialogs.Wpf.ProgressDialog.Show"/> is called. Changing property has
no effect while the dialog is being displayed.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.ProgressDialog.CancellationPending">
<summary>
Gets a value indicating whether the user has requested cancellation of the operation.
</summary>
<value>
<see langword="true" /> if the user has cancelled the progress dialog; otherwise, <see langword="false" />. The default is <see langword="false" />.
</value>
<remarks>
The event handler for the <see cref="E:Ookii.Dialogs.Wpf.ProgressDialog.DoWork"/> event must periodically check this property and abort the operation
if it returns <see langword="true"/>.
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.ProgressDialog.Animation">
<summary>
Gets or sets the animation to show on the progress dialog.
</summary>
<value>
An instance of <see cref="T:Ookii.Dialogs.Wpf.AnimationResource"/> which specifies the animation to show, or <see langword="null"/>
to show no animation. The default value is <see langword="null"/>.
</value>
<remarks>
<para>
This property has no effect on Windows Vista or later. On Windows XP, this property will default to
a flying papers animation.
</para>
<para>
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
no effect while the dialog is being displayed.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.ProgressDialog.ProgressBarStyle">
<summary>
Gets or sets a value that indicates whether a regular or marquee style progress bar should be used.
</summary>
<value>
One of the values of <see cref="T:Ookii.Dialogs.Wpf.ProgressBarStyle"/>.
The default value is <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.ProgressBar"/>.
</value>
<remarks>
<note>
Operating systems older than Windows Vista do not support marquee progress bars on the progress dialog. On those operating systems, the
progress bar will be hidden completely if this property is <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.MarqueeProgressBar"/>.
</note>
<para>
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
the value of the progress bar. When this property is set to <see cref="F:Ookii.Dialogs.Wpf.ProgressBarStyle.MarqueeProgressBar"/>
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,
but the percentage will be ignored.
</para>
<para>
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
no effect while the dialog is being displayed.
</para>
</remarks>
</member>
<member name="P:Ookii.Dialogs.Wpf.ProgressDialog.IsBusy">
<summary>
Gets a value that indicates whether the <see cref="T:Ookii.Dialogs.Wpf.ProgressDialog"/> is running an asynchronous operation.