diff options
Diffstat (limited to 'win')
| -rw-r--r-- | win/CS/HandBrakeCS.csproj | 3 | ||||
| -rw-r--r-- | win/CS/frmMain.Designer.cs | 7 | ||||
| -rw-r--r-- | win/CS/frmMain.cs | 17 | ||||
| -rw-r--r-- | win/CS/frmMain.resx | 27 | ||||
| -rw-r--r-- | win/CS/libraries/OokiiDialogs/Ookii.Dialogs.Wpf.dll | bin | 0 -> 68608 bytes | |||
| -rw-r--r-- | win/CS/libraries/OokiiDialogs/Ookii.Dialogs.XML | 3471 | ||||
| -rw-r--r-- | win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll | bin | 0 -> 133296 bytes | |||
| -rw-r--r-- | win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll.config | 3 | ||||
| -rw-r--r-- | win/CS/libraries/OokiiDialogs/license.txt | 29 | ||||
| -rw-r--r-- | win/CS/libraries/ProgressBar/License.txt | 22 | ||||
| -rw-r--r-- | win/CS/libraries/ProgressBar/Windows7ProgressBar.XML | 106 | ||||
| -rw-r--r-- | win/CS/libraries/ProgressBar/Windows7ProgressBar.dll | bin | 0 -> 20480 bytes | |||
| -rw-r--r-- | win/CS/libraries/Source/HandBrakeInteropSource.zip | bin | 42557 -> 0 bytes |
13 files changed, 3651 insertions, 34 deletions
diff --git a/win/CS/HandBrakeCS.csproj b/win/CS/HandBrakeCS.csproj index b728fe77f..ca931e2c4 100644 --- a/win/CS/HandBrakeCS.csproj +++ b/win/CS/HandBrakeCS.csproj @@ -155,6 +155,9 @@ <HintPath>libraries\Growl.CoreLibrary.dll</HintPath>
<Private>True</Private>
</Reference>
+ <Reference Include="Ookii.Dialogs.Wpf">
+ <HintPath>libraries\OokiiDialogs\Ookii.Dialogs.Wpf.dll</HintPath>
+ </Reference>
<Reference Include="PresentationCore">
<RequiredTargetFramework>3.0</RequiredTargetFramework>
</Reference>
diff --git a/win/CS/frmMain.Designer.cs b/win/CS/frmMain.Designer.cs index 34cd082c0..96a8853bb 100644 --- a/win/CS/frmMain.Designer.cs +++ b/win/CS/frmMain.Designer.cs @@ -825,7 +825,7 @@ namespace Handbrake this.AudioSettings.Font = new System.Drawing.Font("Tahoma", 8.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(0)));
this.AudioSettings.Location = new System.Drawing.Point(0, 0);
this.AudioSettings.Name = "AudioSettings";
- this.AudioSettings.ScannedTracks = ((System.ComponentModel.BindingList<HandBrake.ApplicationServices.Parsing.Audio>)(resources.GetObject("AudioSettings.ScannedTracks")));
+ this.AudioSettings.ScannedTracks = null;
this.AudioSettings.Size = new System.Drawing.Size(720, 310);
this.AudioSettings.TabIndex = 0;
//
@@ -1433,15 +1433,18 @@ namespace Handbrake this.MnuCheckForUpdates,
this.toolStripSeparator11,
this.MnuAboutHandBrake});
+ this.toolStripDropDownButton1.Font = new System.Drawing.Font("Segoe UI", 9F, System.Drawing.FontStyle.Bold, System.Drawing.GraphicsUnit.Point, ((byte)(0)));
this.toolStripDropDownButton1.Image = global::Handbrake.Properties.Resources.Help24;
this.toolStripDropDownButton1.ImageScaling = System.Windows.Forms.ToolStripItemImageScaling.None;
this.toolStripDropDownButton1.ImageTransparentColor = System.Drawing.Color.Magenta;
+ this.toolStripDropDownButton1.Margin = new System.Windows.Forms.Padding(0, 1, 8, 2);
this.toolStripDropDownButton1.Name = "toolStripDropDownButton1";
this.toolStripDropDownButton1.Size = new System.Drawing.Size(69, 36);
this.toolStripDropDownButton1.Text = "Help";
//
// MnuUserGuide
//
+ this.MnuUserGuide.Font = new System.Drawing.Font("Segoe UI", 9F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(0)));
this.MnuUserGuide.Image = global::Handbrake.Properties.Resources.info16;
this.MnuUserGuide.ImageScaling = System.Windows.Forms.ToolStripItemImageScaling.None;
this.MnuUserGuide.Name = "MnuUserGuide";
@@ -1456,6 +1459,7 @@ namespace Handbrake //
// MnuCheckForUpdates
//
+ this.MnuCheckForUpdates.Font = new System.Drawing.Font("Segoe UI", 9F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(0)));
this.MnuCheckForUpdates.Name = "MnuCheckForUpdates";
this.MnuCheckForUpdates.Size = new System.Drawing.Size(192, 24);
this.MnuCheckForUpdates.Text = "Check for Updates";
@@ -1468,6 +1472,7 @@ namespace Handbrake //
// MnuAboutHandBrake
//
+ this.MnuAboutHandBrake.Font = new System.Drawing.Font("Segoe UI", 9F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(0)));
this.MnuAboutHandBrake.Image = global::Handbrake.Properties.Resources.hb16;
this.MnuAboutHandBrake.ImageScaling = System.Windows.Forms.ToolStripItemImageScaling.None;
this.MnuAboutHandBrake.Name = "MnuAboutHandBrake";
diff --git a/win/CS/frmMain.cs b/win/CS/frmMain.cs index 261077aa2..3654e41d1 100644 --- a/win/CS/frmMain.cs +++ b/win/CS/frmMain.cs @@ -31,6 +31,9 @@ namespace Handbrake using Handbrake.ToolWindows;
using Model;
+
+ using Ookii.Dialogs.Wpf;
+
using Properties;
using Main = Handbrake.Functions.Main;
@@ -391,7 +394,6 @@ namespace Handbrake }
#endregion
-
#region Tools Menu
/// <summary>
@@ -1316,11 +1318,12 @@ namespace Handbrake // Source
private void BtnFolderScanClicked(object sender, EventArgs e)
{
+ VistaFolderBrowserDialog modernFolderDialog = new VistaFolderBrowserDialog { ShowNewFolderButton = true, RootFolder = Environment.SpecialFolder.DesktopDirectory };
this.btn_source.HideDropDown();
- if (DVD_Open.ShowDialog() == DialogResult.OK)
+ if (modernFolderDialog.ShowDialog() == true)
{
this.selectedSourceType = SourceType.Folder;
- SelectSource(DVD_Open.SelectedPath, 0);
+ SelectSource(modernFolderDialog.SelectedPath, 0);
}
else
UpdateSourceLabel();
@@ -1379,16 +1382,18 @@ namespace Handbrake private void FolderTitleSpecificScanClick(object sender, EventArgs e)
{
this.btn_source.HideDropDown();
- if (DVD_Open.ShowDialog() == DialogResult.OK)
+
+ VistaFolderBrowserDialog modernFolderDialog = new VistaFolderBrowserDialog { ShowNewFolderButton = true, RootFolder = Environment.SpecialFolder.DesktopDirectory };
+ if (modernFolderDialog.ShowDialog() == true)
{
this.selectedSourceType = SourceType.Folder;
- int sourceTitle = 0;
+ int sourceTitle;
TitleSpecificScan title = new TitleSpecificScan();
if (title.ShowDialog() == DialogResult.OK)
{
sourceTitle = title.Title;
- SelectSource(DVD_Open.SelectedPath, sourceTitle);
+ SelectSource(modernFolderDialog.SelectedPath, sourceTitle);
}
}
else
diff --git a/win/CS/frmMain.resx b/win/CS/frmMain.resx index a7a22f02a..a737bb095 100644 --- a/win/CS/frmMain.resx +++ b/win/CS/frmMain.resx @@ -233,33 +233,6 @@ to make bitrate allocation decisions.</value> <metadata name="frmMainMenu.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
<value>106, 15</value>
</metadata>
- <data name="AudioSettings.ScannedTracks" mimetype="application/x-microsoft.net.object.binary.base64">
- <value>
- AAEAAAD/////AQAAAAAAAAAMAgAAAElTeXN0ZW0sIFZlcnNpb249NC4wLjAuMCwgQ3VsdHVyZT1uZXV0
- cmFsLCBQdWJsaWNLZXlUb2tlbj1iNzdhNWM1NjE5MzRlMDg5BQEAAACrAVN5c3RlbS5Db21wb25lbnRN
- b2RlbC5CaW5kaW5nTGlzdGAxW1tIYW5kQnJha2UuQXBwbGljYXRpb25TZXJ2aWNlcy5QYXJzaW5nLkF1
- ZGlvLCBIYW5kQnJha2UuQXBwbGljYXRpb25TZXJ2aWNlcywgVmVyc2lvbj0wLjkuNS40MDYxLCBDdWx0
- dXJlPW5ldXRyYWwsIFB1YmxpY0tleVRva2VuPW51bGxdXQgAAAAJYWRkTmV3UG9zFnJhaXNlTGlzdENo
- YW5nZWRFdmVudHMWcmFpc2VJdGVtQ2hhbmdlZEV2ZW50cwhhbGxvd05ldwlhbGxvd0VkaXQLYWxsb3dS
- ZW1vdmUPdXNlclNldEFsbG93TmV3EkNvbGxlY3Rpb25gMStpdGVtcwAAAAAAAAADCAEBAQEBAakBU3lz
- dGVtLkNvbGxlY3Rpb25zLkdlbmVyaWMuTGlzdGAxW1tIYW5kQnJha2UuQXBwbGljYXRpb25TZXJ2aWNl
- cy5QYXJzaW5nLkF1ZGlvLCBIYW5kQnJha2UuQXBwbGljYXRpb25TZXJ2aWNlcywgVmVyc2lvbj0wLjku
- NS40MDYxLCBDdWx0dXJlPW5ldXRyYWwsIFB1YmxpY0tleVRva2VuPW51bGxdXQIAAAD/////AQABAQEA
- CQMAAAAMBAAAAFdIYW5kQnJha2UuQXBwbGljYXRpb25TZXJ2aWNlcywgVmVyc2lvbj0wLjkuNS40MDYx
- LCBDdWx0dXJlPW5ldXRyYWwsIFB1YmxpY0tleVRva2VuPW51bGwEAwAAAKkBU3lzdGVtLkNvbGxlY3Rp
- b25zLkdlbmVyaWMuTGlzdGAxW1tIYW5kQnJha2UuQXBwbGljYXRpb25TZXJ2aWNlcy5QYXJzaW5nLkF1
- ZGlvLCBIYW5kQnJha2UuQXBwbGljYXRpb25TZXJ2aWNlcywgVmVyc2lvbj0wLjkuNS40MDYxLCBDdWx0
- dXJlPW5ldXRyYWwsIFB1YmxpY0tleVRva2VuPW51bGxdXQMAAAAGX2l0ZW1zBV9zaXplCF92ZXJzaW9u
- BAAALUhhbmRCcmFrZS5BcHBsaWNhdGlvblNlcnZpY2VzLlBhcnNpbmcuQXVkaW9bXQQAAAAICAkFAAAA
- AQAAAAEAAAAHBQAAAAABAAAABAAAAAQrSGFuZEJyYWtlLkFwcGxpY2F0aW9uU2VydmljZXMuUGFyc2lu
- Zy5BdWRpbwQAAAAJBgAAAA0DBQYAAAArSGFuZEJyYWtlLkFwcGxpY2F0aW9uU2VydmljZXMuUGFyc2lu
- Zy5BdWRpbwcAAAAcPFRyYWNrTnVtYmVyPmtfX0JhY2tpbmdGaWVsZBk8TGFuZ3VhZ2U+a19fQmFja2lu
- Z0ZpZWxkHTxMYW5ndWFnZUNvZGU+a19fQmFja2luZ0ZpZWxkHDxEZXNjcmlwdGlvbj5rX19CYWNraW5n
- RmllbGQXPEZvcm1hdD5rX19CYWNraW5nRmllbGQbPFNhbXBsZVJhdGU+a19fQmFja2luZ0ZpZWxkGDxC
- aXRyYXRlPmtfX0JhY2tpbmdGaWVsZAABAQEBAAAICAgEAAAAAAAAAAoKBgcAAAAKTm9uZSBGb3VuZAoA
- AAAAAAAAAAs=
-</value>
- </data>
<metadata name="AudioMenuRowHeightHack.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
<value>17, 54</value>
</metadata>
diff --git a/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.Wpf.dll b/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.Wpf.dll Binary files differnew file mode 100644 index 000000000..55cc4f3ef --- /dev/null +++ b/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.Wpf.dll diff --git a/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.XML b/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.XML new file mode 100644 index 000000000..99e45451f --- /dev/null +++ b/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.XML @@ -0,0 +1,3471 @@ +<?xml version="1.0"?>
+<doc>
+ <assembly>
+ <name>Ookii.Dialogs</name>
+ </assembly>
+ <members>
+ <member name="T:Ookii.Dialogs.ShellAnimation">
+ <summary>
+ Resource identifiers for default animations from shell32.dll.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ShellAnimation.FileMove">
+ <summary>
+ An animation representing a file move.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ShellAnimation.FileCopy">
+ <summary>
+ An animation representing a file copy.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ShellAnimation.FlyingPapers">
+ <summary>
+ An animation showing flying papers.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ShellAnimation.SearchGlobe">
+ <summary>
+ An animation showing a magnifying glass over a globe.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ShellAnimation.PermanentDelete">
+ <summary>
+ An animation representing a permament delete.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ShellAnimation.FromRecycleBinDelete">
+ <summary>
+ An animation representing deleting an item from the recycle bin.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ShellAnimation.ToRecycleBinDelete">
+ <summary>
+ An animation representing a file move to the recycle bin.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ShellAnimation.SearchComputer">
+ <summary>
+ An animation representing a search spanning the local computer.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ShellAnimation.SearchDocument">
+ <summary>
+ An animation representing a search in a document..
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ShellAnimation.SearchFlashlight">
+ <summary>
+ An animation representing a search using a flashlight animation.
+ </summary>
+ </member>
+ <member name="T:Ookii.Dialogs.DownlevelTextMode">
+ <summary>
+ An enumeration that displays how the text in the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.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.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.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.DownlevelTextMode.MainInstructionAndContent">
+ <summary>
+ The text of the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/> properties is
+ concatenated together, separated by an empty line.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.DownlevelTextMode.MainInstructionOnly">
+ <summary>
+ Only the text of the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> property is shown.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.DownlevelTextMode.ContentOnly">
+ <summary>
+ Only the text of the <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/> property is shown.
+ </summary>
+ </member>
+ <member name="T:Ookii.Dialogs.AnimationResource">
+ <summary>
+ Represents an animation for the <see cref="T:Ookii.Dialogs.ProgressDialog"/> loaded from a Win32 resource.
+ </summary>
+ <threadsafety instance="false" static="true"/>
+ </member>
+ <member name="M:Ookii.Dialogs.AnimationResource.#ctor(System.String,System.Int32)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.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="M:Ookii.Dialogs.AnimationResource.GetShellAnimation(Ookii.Dialogs.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.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.ShellAnimation"/> enumeration.</exception>
+ </member>
+ <member name="P:Ookii.Dialogs.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.AnimationResource.ResourceId">
+ <summary>
+ Gets the ID of the animation resource.
+ </summary>
+ <value>
+ The ID of the animation resource.
+ </value>
+ </member>
+ <member name="T:Ookii.Dialogs.TaskDialog">
+ <summary>
+ Displays a Task Dialog.
+ </summary>
+ <remarks>
+ The task dialog contains an application-defined message text and title, icons, and any combination of predefined push buttons.
+ Task Dialogs are supported only on Windows Vista and above. No fallback is provided; if you wish to use task dialogs
+ and support operating systems older than Windows Vista, you must provide a fallback yourself. Check the <see cref="P:Ookii.Dialogs.TaskDialog.OSSupportsTaskDialogs"/>
+ property to see if task dialogs are supported. It is safe to instantiate the <see cref="T:Ookii.Dialogs.TaskDialog"/> class on an older
+ OS, but calling <see cref="M:Ookii.Dialogs.TaskDialog.Show"/> or <see cref="M:Ookii.Dialogs.TaskDialog.ShowDialog"/> will throw an exception.
+ </remarks>
+ <threadsafety static="true" instance="false"/>
+ </member>
+ <member name="F:Ookii.Dialogs.TaskDialog.components">
+ <summary>
+ Required designer variable.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.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.TaskDialog.InitializeComponent">
+ <summary>
+ Required method for Designer support - do not modify
+ the contents of this method with the code editor.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialog"/> class.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.#ctor(System.ComponentModel.IContainer)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialog"/> class with the specified container.
+ </summary>
+ <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.TaskDialog"/> to.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.Show">
+ <summary>
+ Shows the task dialog as a modeless dialog.
+ </summary>
+ <returns>The button that the user clicked. Can be <see langword="null"/> if the user cancelled the dialog using the
+ title bar close button.</returns>
+ <remarks>
+ <note>
+ Although the dialog is modeless, this method does not return until the task dialog is closed.
+ </note>
+ </remarks>
+ <exception cref="T:System.InvalidOperationException">
+ <para>
+ One of the properties or a combination of properties is not valid.
+ </para>
+ <para>
+ -or-
+ </para>
+ <para>
+ The dialog is already running.
+ </para>
+ </exception>
+ <exception cref="T:System.NotSupportedException">Task dialogs are not supported on the current operating system.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.ShowDialog">
+ <summary>
+ Shows the task dialog as a modal dialog.
+ </summary>
+ <returns>The button that the user clicked. Can be <see langword="null"/> if the user cancelled the dialog using the
+ title bar close button.</returns>
+ <remarks>
+ The dialog will use the active window as its owner. If the current process has no active window,
+ the dialog will be displayed as a modeless dialog (identical to calling <see cref="M:Ookii.Dialogs.TaskDialog.Show"/>).
+ </remarks>
+ <exception cref="T:System.InvalidOperationException">
+ <para>
+ One of the properties or a combination of properties is not valid.
+ </para>
+ <para>
+ -or-
+ </para>
+ <para>
+ The dialog is already running.
+ </para>
+ </exception>
+ <exception cref="T:System.NotSupportedException">Task dialogs are not supported on the current operating system.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.ShowDialog(System.Windows.Forms.IWin32Window)">
+ <summary>
+ This method is for internal Ookii.Dialogs use and should not be called from your code.
+ </summary>
+ <param name="owner"></param>
+ <returns></returns>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.ClickVerification(System.Boolean,System.Boolean)">
+ <summary>
+ Simulates a click on the verification checkbox of the <see cref="T:Ookii.Dialogs.TaskDialog"/>, if it exists.
+ </summary>
+ <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>
+ <param name="setFocus"><see langword="true"/> to set the keyboard focus to the checkbox; otherwise <see langword="false"/>.</param>
+ <exception cref="T:System.InvalidOperationException">The task dialog is not being displayed.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.OnHyperlinkClicked(Ookii.Dialogs.HyperlinkClickedEventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.HyperlinkClicked"/> event.
+ </summary>
+ <param name="e">The <see cref="T:Ookii.Dialogs.HyperlinkClickedEventArgs"/> containing the data for the event.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.OnButtonClicked(Ookii.Dialogs.TaskDialogItemClickedEventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.ButtonClicked"/> event.
+ </summary>
+ <param name="e">The <see cref="T:Ookii.Dialogs.TaskDialogItemClickedEventArgs"/> containing the data for the event.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.OnRadioButtonClicked(Ookii.Dialogs.TaskDialogItemClickedEventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.RadioButtonClicked"/> event.
+ </summary>
+ <param name="e">The <see cref="T:Ookii.Dialogs.TaskDialogItemClickedEventArgs"/> containing the data for the event.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.OnVerificationClicked(System.EventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.VerificationClicked"/> event.
+ </summary>
+ <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.OnCreated(System.EventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.Created"/> event.
+ </summary>
+ <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.OnTimer(Ookii.Dialogs.TimerEventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event.
+ </summary>
+ <param name="e">The <see cref="T:Ookii.Dialogs.TimerEventArgs"/> containing the data for the event.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.OnDestroyed(System.EventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.Destroyed"/> event.
+ </summary>
+ <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.OnExpandButtonClicked(Ookii.Dialogs.ExpandButtonClickedEventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.ExpandButtonClicked"/> event.
+ </summary>
+ <param name="e">The <see cref="T:Ookii.Dialogs.ExpandButtonClickedEventArgs"/> containing the data for the event.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialog.OnHelpRequested(System.EventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.HelpRequested"/> event.
+ </summary>
+ <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>
+ </member>
+ <member name="E:Ookii.Dialogs.TaskDialog.Created">
+ <summary>
+ Event raised when the task dialog has been created.
+ </summary>
+ <remarks>
+ This event is raised once after calling <see cref="M:Ookii.Dialogs.TaskDialog.ShowDialog(System.Windows.Forms.IWin32Window)"/>, after the dialog
+ is created and before it is displayed.
+ </remarks>
+ </member>
+ <member name="E:Ookii.Dialogs.TaskDialog.Destroyed">
+ <summary>
+ Event raised when the task dialog has been destroyed.
+ </summary>
+ <remarks>
+ The task dialog window no longer exists when this event is raised.
+ </remarks>
+ </member>
+ <member name="E:Ookii.Dialogs.TaskDialog.ButtonClicked">
+ <summary>
+ Event raised when the user clicks a button on the task dialog.
+ </summary>
+ <remarks>
+ Set the <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> property to <see langword="true"/> to prevent the dialog from being closed.
+ </remarks>
+ </member>
+ <member name="E:Ookii.Dialogs.TaskDialog.RadioButtonClicked">
+ <summary>
+ Event raised when the user clicks a radio button on the task dialog.
+ </summary>
+ <remarks>
+ The <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> property is ignored for this event.
+ </remarks>
+ </member>
+ <member name="E:Ookii.Dialogs.TaskDialog.HyperlinkClicked">
+ <summary>
+ Event raised when the user clicks a hyperlink.
+ </summary>
+ </member>
+ <member name="E:Ookii.Dialogs.TaskDialog.VerificationClicked">
+ <summary>
+ Event raised when the user clicks the verification check box.
+ </summary>
+ </member>
+ <member name="E:Ookii.Dialogs.TaskDialog.Timer">
+ <summary>
+ Event raised periodically while the dialog is displayed.
+ </summary>
+ <remarks>
+ <para>
+ This event is raised only when the <see cref="P:Ookii.Dialogs.TaskDialog.RaiseTimerEvent"/> property is set to <see langword="true"/>. The event is
+ raised approximately every 200 milliseconds.
+ </para>
+ <para>
+ To reset the tick count, set the <see cref="P:Ookii.Dialogs.TimerEventArgs.ResetTickCount"/>
+ property to <see langword="true"/>.
+ </para>
+ </remarks>
+ </member>
+ <member name="E:Ookii.Dialogs.TaskDialog.ExpandButtonClicked">
+ <summary>
+ Event raised when the user clicks the expand button on the task dialog.
+ </summary>
+ <remarks>
+ The <see cref="P:Ookii.Dialogs.ExpandButtonClickedEventArgs.Expanded"/> property indicates if the expanded information is visible
+ or not after the click.
+ </remarks>
+ </member>
+ <member name="E:Ookii.Dialogs.TaskDialog.HelpRequested">
+ <summary>
+ Event raised when the user presses F1 while the dialog has focus.
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.OSSupportsTaskDialogs">
+ <summary>
+ Gets a value that indicates whether the current operating system supports task dialogs.
+ </summary>
+ <value>
+ Returns <see langword="true" /> for Windows Vista or later; otherwise <see langword="false" />.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.Buttons">
+ <summary>
+ Gets a list of the buttons on the Task Dialog.
+ </summary>
+ <value>
+ A list of the buttons on the Task Dialog.
+ </value>
+ <remarks>
+ Custom buttons are displayed in the order they have in the collection. Standard buttons will always be displayed
+ in the Windows-defined order, regardless of the order of the buttons in the collection.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.RadioButtons">
+ <summary>
+ Gets a list of the radio buttons on the Task Dialog.
+ </summary>
+ <value>
+ A list of the radio buttons on the Task Dialog.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.WindowTitle">
+ <summary>
+ Gets or sets the window title of the task dialog.
+ </summary>
+ <value>
+ The window title of the task dialog. The default is an empty string ("").
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.MainInstruction">
+ <summary>
+ Gets or sets the dialog's main instruction.
+ </summary>
+ <value>
+ The dialog's main instruction. The default is an empty string ("").
+ </value>
+ <remarks>
+ The main instruction of a task dialog will be displayed in a larger font and a different color than
+ the other text of the task dialog.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.Content">
+ <summary>
+ Gets or sets the dialog's primary content.
+ </summary>
+ <value>
+ The dialog's primary content. The default is an empty string ("").
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.WindowIcon">
+ <summary>
+ Gets or sets the icon to be used in the title bar of the dialog.
+ </summary>
+ <value>
+ An <see cref="T:System.Drawing.Icon"/> that represents the icon of the task dialog's window.
+ </value>
+ <remarks>
+ This property is used only when the dialog is shown as a modeless dialog; if the dialog
+ is modal, it will have no icon.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.MainIcon">
+ <summary>
+ Gets or sets the icon to display in the task dialog.
+ </summary>
+ <value>
+ A <see cref="T:Ookii.Dialogs.TaskDialogIcon"/> that indicates the icon to display in the main content area of the task dialog.
+ The default is <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>.
+ </value>
+ <remarks>
+ When this property is set to <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>, use the <see cref="P:Ookii.Dialogs.TaskDialog.CustomMainIcon"/> property to
+ specify the icon to use.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.CustomMainIcon">
+ <summary>
+ Gets or sets a custom icon to display in the dialog.
+ </summary>
+ <value>
+ An <see cref="T:System.Drawing.Icon"/> that represents the icon to display in the main content area of the task dialog,
+ or <see langword="null"/> if no custom icon is used. The default value is <see langword="null"/>.
+ </value>
+ <remarks>
+ This property is ignored if the <see cref="P:Ookii.Dialogs.TaskDialog.MainIcon"/> property has a value other than <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.FooterIcon">
+ <summary>
+ Gets or sets the icon to display in the footer area of the task dialog.
+ </summary>
+ <value>
+ A <see cref="T:Ookii.Dialogs.TaskDialogIcon"/> that indicates the icon to display in the footer area of the task dialog.
+ The default is <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>.
+ </value>
+ <remarks>
+ <para>
+ When this property is set to <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>, use the <see cref="P:Ookii.Dialogs.TaskDialog.CustomFooterIcon"/> property to
+ specify the icon to use.
+ </para>
+ <para>
+ The footer icon is displayed only if the <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> property is not an empty string ("").
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.CustomFooterIcon">
+ <summary>
+ Gets or sets a custom icon to display in the footer area of the task dialog.
+ </summary>
+ <value>
+ An <see cref="T:System.Drawing.Icon"/> that represents the icon to display in the footer area of the task dialog,
+ or <see langword="null"/> if no custom icon is used. The default value is <see langword="null"/>.
+ </value>
+ <remarks>
+ <para>
+ This property is ignored if the <see cref="P:Ookii.Dialogs.TaskDialog.FooterIcon"/> property has a value other than <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>.
+ </para>
+ <para>
+ The footer icon is displayed only if the <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> property is not an empty string ("").
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.ButtonStyle">
+ <summary>
+ Gets or sets a value that indicates whether custom buttons should be displayed as normal buttons or command links.
+ </summary>
+ <value>
+ A <see cref="T:Ookii.Dialogs.TaskDialogButtonStyle"/> that indicates the display style of custom buttons on the dialog.
+ The default value is <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.Standard"/>.
+ </value>
+ <remarks>
+ <para>
+ This property affects only custom buttons, not standard ones.
+ </para>
+ <para>
+ If a custom button is being displayed on a task dialog
+ with <see cref="P:Ookii.Dialogs.TaskDialog.ButtonStyle"/> set to <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinks"/>
+ or <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinksNoIcon"/>, you delineate the command from the
+ note by placing a line break in the string specified by <see cref="P:Ookii.Dialogs.TaskDialogItem.Text"/> property.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.VerificationText">
+ <summary>
+ Gets or sets the label for the verification checkbox.
+ </summary>
+ <value>
+ The label for the verification checkbox, or an empty string ("") if no verification checkbox
+ is shown. The default value is an empty string ("").
+ </value>
+ <remarks>
+ If no text is set, the verification checkbox will not be shown.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.IsVerificationChecked">
+ <summary>
+ Gets or sets a value that indicates whether the verification checkbox is checked ot not.
+ </summary>
+ <value>
+ <see langword="true"/> if the verficiation checkbox is checked; otherwise, <see langword="false"/>.
+ </value>
+ <remarks>
+ <para>
+ Set this property before displaying the dialog to determine the initial state of the check box.
+ Use this property after displaying the dialog to determine whether the check box was checked when
+ the user closed the dialog.
+ </para>
+ <note>
+ This property is only used if <see cref="P:Ookii.Dialogs.TaskDialog.VerificationText"/> is not an empty string ("").
+ </note>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.ExpandedInformation">
+ <summary>
+ Gets or sets additional information to be displayed on the dialog.
+ </summary>
+ <value>
+ Additional information to be displayed on the dialog. The default value is an empty string ("").
+ </value>
+ <remarks>
+ <para>
+ When this property is not an empty string (""), a control is shown on the task dialog that
+ allows the user to expand and collapse the text specified in this property.
+ </para>
+ <para>
+ The text is collapsed by default unless <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedByDefault"/> is set to <see langword="true"/>.
+ </para>
+ <para>
+ The expanded text is shown in the main content area of the dialog, unless <see cref="P:Ookii.Dialogs.TaskDialog.ExpandFooterArea"/>
+ is set to <see langword="true"/>, in which case it is shown in the footer area.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.ExpandedControlText">
+ <summary>
+ Gets or sets the text to use for the control for collapsing the expandable information specified in <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>.
+ </summary>
+ <value>
+ The text to use for the control for collapsing the expandable information, or an empty string ("") if the
+ operating system's default text is to be used. The default is an empty string ("")
+ </value>
+ <remarks>
+ <para>
+ If this text is not specified and <see cref="P:Ookii.Dialogs.TaskDialog.CollapsedControlText"/> is specified, the value of <see cref="P:Ookii.Dialogs.TaskDialog.CollapsedControlText"/>
+ will be used for this property as well. If neither is specified, the operating system's default text is used.
+ </para>
+ <note>
+ The control for collapsing or expanding the expandable information is displayed only if <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> is not
+ an empty string ("")
+ </note>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.CollapsedControlText">
+ <summary>
+ Gets or sets the text to use for the control for expading the expandable information specified in <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>.
+ </summary>
+ <value>
+ The text to use for the control for expanding the expandable information, or an empty string ("") if the
+ operating system's default text is to be used. The default is an empty string ("")
+ </value>
+ <remarks>
+ <para>
+ If this text is not specified and <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedControlText"/> is specified, the value of <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedControlText"/>
+ will be used for this property as well. If neither is specified, the operating system's default text is used.
+ </para>
+ <note>
+ The control for collapsing or expanding the expandable information is displayed only if <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> is not
+ an empty string ("")
+ </note>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.Footer">
+ <summary>
+ Gets or sets the text to be used in the footer area of the task dialog.
+ </summary>
+ <value>
+ The text to be used in the footer area of the task dialog, or an empty string ("")
+ if the footer area is not displayed. The default value is an empty string ("").
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.Width">
+ <summary>
+ Specifies the width of the task dialog's client area in DLU's.
+ </summary>
+ <value>
+ The width of the task dialog's client area in DLU's, or 0 to have the task dialog calculate the ideal width.
+ The default value is 0.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.EnableHyperlinks">
+ <summary>
+ Gets or sets a value that indicates whether hyperlinks are allowed for the <see cref="P:Ookii.Dialogs.TaskDialog.Content"/>, <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>
+ and <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> properties.
+ </summary>
+ <value>
+ <see langword="true"/> when hyperlinks are allowed for the <see cref="P:Ookii.Dialogs.TaskDialog.Content"/>, <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>
+ and <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> properties; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
+ </value>
+ <remarks>
+ <para>
+ When this property is <see langword="true"/>, the <see cref="P:Ookii.Dialogs.TaskDialog.Content"/>, <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>
+ and <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> properties can use hyperlinks in the following form: <c><A HREF="executablestring">Hyperlink Text</A></c>
+ </para>
+ <note>
+ Enabling hyperlinks when using content from an unsafe source may cause security vulnerabilities.
+ </note>
+ <para>
+ Task dialogs will not actually execute hyperlinks. To take action when the user presses a hyperlink, handle the
+ <see cref="E:Ookii.Dialogs.TaskDialog.HyperlinkClicked"/> event.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.AllowDialogCancellation">
+ <summary>
+ Gets or sets a value that indicates that the dialog should be able to be closed using Alt-F4, Escape and the title
+ bar's close button even if no cancel button is specified.
+ </summary>
+ <value>
+ <see langword="true" /> if the dialog can be closed using Alt-F4, Escape and the title
+ bar's close button even if no cancel button is specified; otherwise, <see langword="false" />.
+ The default value is <see langword="false" />.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.ExpandFooterArea">
+ <summary>
+ Gets or sets a value that indicates that the string specified by the <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> property
+ should be displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content.
+ </summary>
+ <value>
+ <see langword="true"/> if the string specified by the <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> property
+ should be displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content;
+ otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.ExpandedByDefault">
+ <summary>
+ Gets or sets a value that indicates that the string specified by the <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> property
+ should be displayed by default.
+ </summary>
+ <value>
+ <see langword="true"/> if the string specified by the <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> property
+ should be displayed by default; <see langword="false"/> if it is hidden by default. The default value is
+ <see langword="false"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.RaiseTimerEvent">
+ <summary>
+ Gets or sets a value that indicates whether the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event is raised periodically while the dialog
+ is visible.
+ </summary>
+ <value>
+ <see langword="true"/> when the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event is raised periodically while the dialog is visible; otherwise,
+ <see langword="false"/>. The default value is <see langword="false"/>.
+ </value>
+ <remarks>
+ The <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event will be raised approximately every 200 milliseconds if this property is <see langword="true"/>.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.CenterParent">
+ <summary>
+ Gets or sets a value that indicates whether the dialog is centered in the parent window instead of the screen.
+ </summary>
+ <value>
+ <see langword="true" /> when the dialog is centered relative to the parent window; <see langword="false" /> when it is centered on the screen.
+ The default value is <see langword="false" />.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.RightToLeft">
+ <summary>
+ Gets or sets a value that indicates whether text is displayed right to left.
+ </summary>
+ <value>
+ <see langword="true" /> when the content of the dialog is displayed right to left; otherwise, <see langword="false" />.
+ The default value is <see langword="false" />.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.MinimizeBox">
+ <summary>
+ Gets or sets a value that indicates whether the dialog has a minimize box on its caption bar.
+ </summary>
+ <value>
+ <see langword="true" /> if the dialog has a minimize box on its caption bar when modeless; otherwise,
+ <see langword="false" />. The default is <see langword="false" />.
+ </value>
+ <remarks>
+ A task dialog can only have a minimize box if it is displayed as a modeless dialog. The minimize box
+ will never appear when using the designer "Preview" option, since that displays the dialog modally.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle">
+ <summary>
+ Gets or sets the type of progress bar displayed on the dialog.
+ </summary>
+ <value>
+ A <see cref="T:Ookii.Dialogs.ProgressBarStyle"/> that indicates the type of progress bar shown on the task dialog.
+ </value>
+ <remarks>
+ <para>
+ If this property is set to <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>, the marquee will
+ scroll as long as the dialog is visible.
+ </para>
+ <para>
+ If this property is set to <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>, the value of the
+ <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarValue"/> property must be updated to advance the progress bar. This can be done e.g. by
+ an asynchronous operation or from the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event.
+ </para>
+ <note>
+ Updating the value of the progress bar using the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarValue"/> while the dialog is visible property may only be done from
+ the thread on which the task dialog was created.
+ </note>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarMarqueeAnimationSpeed">
+ <summary>
+ Gets or sets the marquee animation speed of the progress bar in milliseconds.
+ </summary>
+ <value>
+ The marquee animation speed of the progress bar in milliseconds. The default value is 100.
+ </value>
+ <remarks>
+ This property is only used if the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle"/> property is
+ <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarMinimum">
+ <summary>
+ Gets or sets the lower bound of the range of the task dialog's progress bar.
+ </summary>
+ <value>
+ The lower bound of the range of the task dialog's progress bar. The default value is 0.
+ </value>
+ <remarks>
+ This property is only used if the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle"/> property is
+ <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.
+ </remarks>
+ <exception cref="T:System.ArgumentOutOfRangeException">The new property value is not smaller than <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarMaximum"/>.</exception>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarMaximum">
+ <summary>
+ Gets or sets the upper bound of the range of the task dialog's progress bar.
+ </summary>
+ <value>
+ The upper bound of the range of the task dialog's progress bar. The default value is 100.
+ </value>
+ <remarks>
+ This property is only used if the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle"/> property is
+ <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.
+ </remarks>
+ <exception cref="T:System.ArgumentOutOfRangeException">The new property value is not larger than <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarMinimum"/>.</exception>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarValue">
+ <summary>
+ Gets or sets the current value of the task dialog's progress bar.
+ </summary>
+ <value>
+ The current value of the task dialog's progress bar. The default value is 0.
+ </value>
+ <remarks>
+ This property is only used if the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle"/> property is
+ <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.
+ <note>
+ Updating the value of the progress bar while the dialog is visible may only be done from
+ the thread on which the task dialog was created.
+ </note>
+ </remarks>
+ <exception cref="T:System.ArgumentOutOfRangeException">The new property value is smaller than <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarMinimum"/> or larger than <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarMaximum"/>.</exception>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarState">
+ <summary>
+ Gets or sets the state of the task dialog's progress bar.
+ </summary>
+ <value>
+ A <see cref="T:Ookii.Dialogs.ProgressBarState"/> indicating the state of the task dialog's progress bar.
+ The default value is <see cref="F:Ookii.Dialogs.ProgressBarState.Normal"/>.
+ </value>
+ <remarks>
+ This property is only used if the <see cref="T:Ookii.Dialogs.ProgressBarStyle"/> property is
+ <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.Tag">
+ <summary>
+ Gets or sets an object that contains data about the dialog.
+ </summary>
+ <value>
+ An object that contains data about the dialog. The default value is <see langword="null" />.
+ </value>
+ <remarks>
+ Use this property to store arbitrary information about the dialog.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialog.Handle">
+ <summary>
+ Gets the window handle of the task dialog.
+ </summary>
+ <value>
+ The window handle of the task dialog when it is being displayed, or <see cref="F:System.IntPtr.Zero"/> when the dialog
+ is not being displayed.
+ </value>
+ </member>
+ <member name="T:Ookii.Dialogs.TaskDialogItemCollection`1">
+ <summary>
+ Represents a list of <see cref="T:Ookii.Dialogs.TaskDialogItem"/> objects.
+ </summary>
+ <typeparam name="T">The type of the task dialog item.</typeparam>
+ <threadsafety instance="false" static="true"/>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogItemCollection`1.ClearItems">
+ <summary>
+ Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.ClearItems"/> method.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogItemCollection`1.InsertItem(System.Int32,`0)">
+ <summary>
+ Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.InsertItem(System.Int32,`0)"/> method.
+ </summary>
+ <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
+ <param name="item">The object to insert. May not be <see langword="null"/>.</param>
+ <exception cref="T:System.ArgumentNullException"><paramref name="item"/> is <see langword="null"/>.</exception>
+ <exception cref="T:System.ArgumentException">The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> specified in <paramref name="item"/> is already associated with a different task dialog.</exception>
+ <exception cref="T:System.InvalidOperationException">The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> specified in <paramref name="item"/> has a duplicate id or button type.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">
+ <para>
+ <paramref name="index"/> is less than zero.
+ </para>
+ <para>
+ -or-
+ </para>
+ <para>
+ <paramref name="index"/> is equal to or greater than <see cref="P:System.Collections.ObjectModel.Collection`1.Count"/>.
+ </para>
+ </exception>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogItemCollection`1.RemoveItem(System.Int32)">
+ <summary>
+ Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.RemoveItem(System.Int32)"/> method.
+ </summary>
+ <param name="index">The zero-based index of the element to remove.</param>
+ <exception cref="T:System.ArgumentOutOfRangeException">
+ <para>
+ <paramref name="index"/> is less than zero.
+ </para>
+ <para>
+ -or-
+ </para>
+ <para>
+ <paramref name="index"/> is equal to or greater than <see cref="P:System.Collections.ObjectModel.Collection`1.Count"/>.
+ </para>
+ </exception>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogItemCollection`1.SetItem(System.Int32,`0)">
+ <summary>
+ Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.SetItem(System.Int32,`0)"/> method.
+ </summary>
+ <param name="index">The zero-based index of the element to replace.</param>
+ <param name="item">The new value for the element at the specified index. May not be <see langword="null"/>.</param>
+ <exception cref="T:System.ArgumentNullException"><paramref name="item"/> is <see langword="null"/>.</exception>
+ <exception cref="T:System.ArgumentException">The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> specified in <paramref name="item"/> is already associated with a different task dialog.</exception>
+ <exception cref="T:System.InvalidOperationException">The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> specified in <paramref name="item"/> has a duplicate id or button type.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">
+ <para>
+ <paramref name="index"/> is less than zero.
+ </para>
+ <para>
+ -or-
+ </para>
+ <para>
+ <paramref name="index"/> is equal to or greater than <see cref="P:System.Collections.ObjectModel.Collection`1.Count"/>.
+ </para>
+ </exception>
+ </member>
+ <member name="T:Ookii.Dialogs.ProgressBarState">
+ <summary>
+ Represents the state of the progress bar on the task dialog.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ProgressBarState.Normal">
+ <summary>
+ Normal state.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ProgressBarState.Error">
+ <summary>
+ Error state
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ProgressBarState.Paused">
+ <summary>
+ Paused state
+ </summary>
+ </member>
+ <member name="T:Ookii.Dialogs.ExtendedForm">
+ <summary>
+ Base class for windows forms with extended functionality.
+ </summary>
+ <remarks>
+ <para>
+ In order to use this class, create a new Form in Visual Studio, then modify the base
+ class in the .cs (or in Visual Basic, the .Designer.vb) file for the form to this class.
+ </para>
+ <para>
+ This class provides two main pieces of functionality: the ability to use the system font
+ and the ability to use client area glass in Windows Vista.
+ </para>
+ <para>
+ Windows Forms applications will normally always use MS Sans Serif 8pt, even when the
+ system font is something else. For example, on Windows XP (English), the system font
+ is Tahoma 8pt. On Windows XP Japanese, the system font is MS UI Gothic 8pt. On Windows
+ Vista it is Segoe UI 9pt. By setting the <see cref="P:Ookii.Dialogs.ExtendedForm.UseSystemFont"/> property to <see langword="true"/> for a form,
+ that form will automatically use the proper system font.
+ </para>
+ <para>
+ Because the font metrics of these different fonts can be vary greatly
+ (especially on Vista which uses a larger font), please make sure the
+ <see cref="P:System.Windows.Forms.ContainerControl.AutoScaleMode"/> property is set to
+ <see cref="F:System.Windows.Forms.AutoScaleMode.Font"/>, and make special provisions for resizing
+ graphics and other elements.
+ Please note that some system fonts (such as MS UI Gothic) can also be smaller than MS Sans Serif
+ which means the form will be scaled down, not up.
+ </para>
+ <note>
+ If you set <see cref="P:Ookii.Dialogs.ExtendedForm.UseSystemFont"/> to <see langword="true"/>, it is strongly recommended you
+ test your application with various different font and DPI settings.
+ </note>
+ <para>
+ To use glass with your form, use the <see cref="P:Ookii.Dialogs.ExtendedForm.GlassMargin"/> property. You can also
+ specify whether it's possible to drag the form by its glass areas using the <see cref="P:Ookii.Dialogs.ExtendedForm.AllowGlassDragging"/>
+ property. Glass requires Windows Vista with the Desktop Window Manager enabled. The glass related
+ properties have no effect on other operating systems.
+ </para>
+ <note>
+ Many Windows Forms controls will not display correctly when placed over a glass area. Use the
+ <see cref="M:Ookii.Dialogs.Glass.DrawCompositedText(System.Drawing.IDeviceContext,System.String,System.Drawing.Font,System.Drawing.Rectangle,System.Windows.Forms.Padding,System.Drawing.Color,System.Int32,System.Windows.Forms.TextFormatFlags)"/> method to display text on a glass area.
+ </note>
+ <para>
+ This class will automatically handle changes in the system font or DWM settings (including enabling/disabling
+ of the DWM) while the application is running.
+ </para>
+ </remarks>
+ <threadsafety instance="false" static="true"/>
+ </member>
+ <member name="M:Ookii.Dialogs.ExtendedForm.#ctor">
+ <summary>
+ Creates a new instance of the <see cref="T:Ookii.Dialogs.ExtendedForm"/> class.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.ExtendedForm.OnDwmCompositionChanged(System.EventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.ExtendedForm.DwmCompositionChanged"/> event.
+ </summary>
+ <param name="e">An <see cref="T:System.EventArgs"/> containing the event data.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.ExtendedForm.OnLoad(System.EventArgs)">
+ <summary>
+ Overrides the <see cref="M:System.Windows.Forms.Form.OnLoad(System.EventArgs)"/> method.
+ </summary>
+ <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.ExtendedForm.OnFormClosed(System.Windows.Forms.FormClosedEventArgs)">
+ <summary>
+ Overrides the <see cref="M:System.Windows.Forms.Form.OnFormClosed(System.Windows.Forms.FormClosedEventArgs)"/> method.
+ </summary>
+ <param name="e">A <see cref="T:System.Windows.Forms.FormClosedEventArgs"/> that contains the event data.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.ExtendedForm.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
+ <summary>
+ Paints the background of the control.
+ </summary>
+ <param name="pevent">A <see cref="T:System.Windows.Forms.PaintEventArgs"/> that contains the event data.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.ExtendedForm.OnResize(System.EventArgs)">
+ <summary>
+ This member overrides <see cref="M:System.Windows.Forms.Form.OnResize(System.EventArgs)"/>.
+ </summary>
+ <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.ExtendedForm.OnHandleCreated(System.EventArgs)">
+ <summary>
+ This member overrides <see cref="M:System.Windows.Forms.Form.OnHandleCreated(System.EventArgs)"/>.
+ </summary>
+ <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.ExtendedForm.WndProc(System.Windows.Forms.Message@)">
+ <summary>
+ This member overrides <see cref="M:System.Windows.Forms.Form.WndProc(System.Windows.Forms.Message@)"/>.
+ </summary>
+ <param name="m">The Windows <see cref="T:System.Windows.Forms.Message"/> to process.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.ExtendedForm.ScaleControl(System.Drawing.SizeF,System.Windows.Forms.BoundsSpecified)">
+ <summary>
+ Overrides <see cref="M:System.Windows.Forms.Form.ScaleControl(System.Drawing.SizeF,System.Windows.Forms.BoundsSpecified)"/>.
+ </summary>
+ <param name="factor">The height and width of the control's bounds.</param>
+ <param name="specified">A <see cref="T:System.Windows.Forms.BoundsSpecified"/> value that specifies the bounds of the control to use when defining its size and position.</param>
+ </member>
+ <member name="E:Ookii.Dialogs.ExtendedForm.DwmCompositionChanged">
+ <summary>
+ Raised when Desktop Window Manager (DWM) composition has been enabled or disabled.
+ </summary>
+ <remarks>
+ <note>
+ This event is only raised on Windows Vista or later.
+ </note>
+ <para>
+ Use the <see cref="P:Ookii.Dialogs.Glass.IsDwmCompositionEnabled"/> property to determine the
+ current composition state.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.ExtendedForm.UseSystemFont">
+ <summary>
+ Gets or sets a value that indicates whether or not the form automatically uses the system default font.
+ </summary>
+ <value>
+ <see langword="true"/> when the form's font is automatically adjusted to the system font;
+ otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
+ </value>
+ <remarks>
+ <para>
+ This property has no effect at design time; the font settings will only be applied at
+ run time.
+ </para>
+ <para>
+ When this property is set to <see langword="true"/>, the form will use the configured
+ system font and font size automatically, e.g. it will use Segoe UI on Windows Vista and
+ Tahoma on Windows XP. Please make sure the <see cref="P:System.Windows.Forms.ContainerControl.AutoScaleMode"/>
+ property is set to <see cref="F:System.Windows.Forms.AutoScaleMode.Font"/>
+ to account for the different metrics of the various fonts, and make special provisions
+ to scale graphics and other element. Note that the system font can also be smaller than
+ the font you used at design time, causing the form to be scaled down. For example the font
+ MS Gothic UI, used on Japanese versions of Windows (pre-Vista), has smaller metrics than
+ MS Sans Serif.
+ </para>
+ <note>
+ It is strongly recommended to test your application with different font and DPI settings if you set this property
+ to <see langword="true"/>.
+ </note>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.ExtendedForm.GlassMargin">
+ <summary>
+ Gets or sets the glass margins of the form.
+ </summary>
+ <value>
+ A <see cref="T:System.Windows.Forms.Padding"/> that indicates the glass margins of the form. The default value is
+ <see cref="F:System.Windows.Forms.Padding.Empty"/>.
+ </value>
+ <remarks>
+ <note>
+ Client-area glass requires Windows Vista or later with the Desktop Window Manager enabled. If the Desktop
+ Window Manager is not enabled, or an older version of Windows is used, this property is ignored.
+ </note>
+ <para>
+ Client-area glass extends the glass frame used by the Windows Vista Aero user interface into the client
+ area of your window.
+ </para>
+ <para>
+ Use negative margins to create the "sheet of glass" effect where the client area is rendered
+ as a completely glass surface.
+ </para>
+ <para>
+ Text rendered with the <see cref="T:System.Windows.Forms.TextRenderer"/> will not display correctly on the glass area (this includes
+ text drawn by most controls). To draw text on the glass area, use <see cref="M:Ookii.Dialogs.Glass.DrawCompositedText(System.Drawing.IDeviceContext,System.String,System.Drawing.Font,System.Drawing.Rectangle,System.Windows.Forms.Padding,System.Drawing.Color,System.Int32,System.Windows.Forms.TextFormatFlags)"/>.
+ </para>
+ <para>
+ If the form is scaled, which can happen for instance if <see cref="P:Ookii.Dialogs.ExtendedForm.UseSystemFont"/> is <see langword="true"/>,
+ the glass margin will also be scaled.
+ </para>
+ <para>
+ At design time, the glass area will be indicated by a pattern drawn onto the form. This pattern will not
+ be visible at runtime regardless of whether the glass is enabled or not.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.ExtendedForm.AllowGlassDragging">
+ <summary>
+ Gets or sets a value that indicates whether the form can be dragged by the glass areas inside the client area.
+ </summary>
+ <value>
+ <see langword="true"/> when the form can be dragged using the client area glass; otherwise, <see langword="false"/>.
+ The default value is <see langword="false"/>.
+ </value>
+ <remarks>
+ This property has no effect on operating systems older than Windows Vista, when the Desktop Window Manager is disabled
+ or when the <see cref="P:Ookii.Dialogs.ExtendedForm.GlassMargin"/> property is set to zero.
+ </remarks>
+ </member>
+ <member name="F:Ookii.Dialogs.InputDialogForm.components">
+ <summary>
+ Required designer variable.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.InputDialogForm.Dispose(System.Boolean)">
+ <summary>
+ Clean up any resources being used.
+ </summary>
+ <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.InputDialogForm.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.TaskDialogIcon">
+ <summary>
+ Indicates the icon to use for a task dialog.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.TaskDialogIcon.Custom">
+ <summary>
+ A custom icon or no icon if no custom icon is specified.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.TaskDialogIcon.Warning">
+ <summary>
+ System warning icon.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.TaskDialogIcon.Error">
+ <summary>
+ System Error icon.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.TaskDialogIcon.Information">
+ <summary>
+ System Information icon.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.TaskDialogIcon.Shield">
+ <summary>
+ Shield icon.
+ </summary>
+ </member>
+ <member name="T:Ookii.Dialogs.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.ProgressDialog"/> class requires Windows 2000, Windows Me, or newer versions of Windows.
+ </para>
+ </remarks>
+ <threadsafety static="true" instance="false"/>
+ </member>
+ <member name="F:Ookii.Dialogs.ProgressDialog.components">
+ <summary>
+ Required designer variable.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.ProgressDialog.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.ProgressDialog.InitializeComponent">
+ <summary>
+ Required method for Designer support - do not modify
+ the contents of this method with the code editor.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.ProgressDialog.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.ProgressDialog.#ctor(System.ComponentModel.IContainer)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.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="M:Ookii.Dialogs.ProgressDialog.Show">
+ <summary>
+ Displays the progress dialog as a modeless dialog.
+ </summary>
+ <remarks>
+ <para>
+ This function will not block the parent window and will return immediately.
+ </para>
+ <para>
+ Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
+ will not function correctly unless the UI thread continues to handle window messages, so that thread may
+ not be blocked by some other activity. All processing related to the progress dialog must be done in
+ the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.
+ </para>
+ </remarks>
+ <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property
+ could not be loaded.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.ProgressDialog.Show(System.Object)">
+ <summary>
+ Displays the progress dialog as a modeless dialog.
+ </summary>
+ <param name="argument">A parameter for use by the background operation to be executed in the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.</param>
+ <remarks>
+ <para>
+ This function will not block the parent window and return immediately.
+ </para>
+ <para>
+ Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
+ will not function correctly unless the UI thread continues to handle window messages, so that thread may
+ not be blocked by some other activity. All processing related to the progress dialog must be done in
+ the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.
+ </para>
+ </remarks>
+ <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property
+ could not be loaded.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.ProgressDialog.ShowDialog">
+ <summary>
+ Displays the progress dialog as a modal dialog.
+ </summary>
+ <remarks>
+ <para>
+ The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However,
+ the <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> function for the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class will return immediately.
+ The parent window will be disabled as with all modal dialogs.
+ </para>
+ <para>
+ Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
+ will not function correctly unless the UI thread continues to handle window messages, so that thread may
+ not be blocked by some other activity. All processing related to the progress dialog must be done in
+ the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.
+ </para>
+ <para>
+ The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs,
+ but is part of the underlying native progress dialog API so cannot be avoided.
+ </para>
+ <para>
+ When possible, it is recommended that you use a modeless dialog using the <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> function.
+ </para>
+ </remarks>
+ <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property
+ could not be loaded.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.ProgressDialog.ShowDialog(System.Windows.Forms.IWin32Window)">
+ <summary>
+ Displays the progress dialog as a modal dialog.
+ </summary>
+ <param name="owner">The window that owns the dialog.</param>
+ <remarks>
+ <para>
+ The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However,
+ the <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> function for the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class will return immediately.
+ The parent window will be disabled as with all modal dialogs.
+ </para>
+ <para>
+ Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
+ will not function correctly unless the UI thread continues to handle window messages, so that thread may
+ not be blocked by some other activity. All processing related to the progress dialog must be done in
+ the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.
+ </para>
+ <para>
+ The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs,
+ but is part of the underlying native progress dialog API so cannot be avoided.
+ </para>
+ <para>
+ When possible, it is recommended that you use a modeless dialog using the <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> function.
+ </para>
+ </remarks>
+ <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property
+ could not be loaded, or the operation is already running.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.ProgressDialog.ShowDialog(System.Windows.Forms.IWin32Window,System.Object)">
+ <summary>
+ Displays the progress dialog as a modal dialog.
+ </summary>
+ <param name="owner">The window that owns the dialog.</param>
+ <param name="argument">A parameter for use by the background operation to be executed in the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.</param>
+ <remarks>
+ <para>
+ The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However,
+ the <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> function for the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class will return immediately.
+ The parent window will be disabled as with all modal dialogs.
+ </para>
+ <para>
+ Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
+ will not function correctly unless the UI thread continues to handle window messages, so that thread may
+ not be blocked by some other activity. All processing related to the progress dialog must be done in
+ the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.
+ </para>
+ <para>
+ The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs,
+ but is part of the underlying native progress dialog API so cannot be avoided.
+ </para>
+ <para>
+ When possible, it is recommended that you use a modeless dialog using the <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> function.
+ </para>
+ </remarks>
+ <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property
+ could not be loaded, or the operation is already running.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32)">
+ <summary>
+ Updates the dialog's progress bar.
+ </summary>
+ <param name="percentProgress">The percentage, from 0 to 100, of the operation that is complete.</param>
+ <remarks>
+ <para>
+ Call this method from the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler if you want to report progress.
+ </para>
+ <para>
+ This method has no effect is <see cref="P:Ookii.Dialogs.ProgressDialog.ProgressBarStyle"/> is <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>
+ or <see cref="F:Ookii.Dialogs.ProgressBarStyle.None"/>.
+ </para>
+ </remarks>
+ <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="percentProgress"/> is out of range.</exception>
+ <exception cref="T:System.InvalidOperationException">The progress dialog is not currently being displayed.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)">
+ <summary>
+ Updates the dialog's progress bar.
+ </summary>
+ <param name="percentProgress">The percentage, from 0 to 100, of the operation that is complete.</param>
+ <param name="text">The new value of the progress dialog's primary text message, or <see langword="null"/> to leave the value unchanged.</param>
+ <param name="description">The new value of the progress dialog's additional description message, or <see langword="null"/> to leave the value unchanged.</param>
+ <remarks>Call this method from the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler if you want to report progress.</remarks>
+ <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="percentProgress"/> is out of range.</exception>
+ <exception cref="T:System.InvalidOperationException">The progress dialog is not currently being displayed.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String,System.Object)">
+ <summary>
+ Updates the dialog's progress bar.
+ </summary>
+ <param name="percentProgress">The percentage, from 0 to 100, of the operation that is complete.</param>
+ <param name="text">The new value of the progress dialog's primary text message, or <see langword="null"/> to leave the value unchanged.</param>
+ <param name="description">The new value of the progress dialog's additional description message, or <see langword="null"/> to leave the value unchanged.</param>
+ <param name="userState">A state object that will be passed to the <see cref="E:Ookii.Dialogs.ProgressDialog.ProgressChanged"/> event handler.</param>
+ <remarks>Call this method from the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler if you want to report progress.</remarks>
+ <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="percentProgress"/> is out of range.</exception>
+ <exception cref="T:System.InvalidOperationException">The progress dialog is not currently being displayed.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.ProgressDialog.OnDoWork(System.ComponentModel.DoWorkEventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event.
+ </summary>
+ <param name="e">The <see cref="T:System.ComponentModel.DoWorkEventArgs"/> containing data for the event.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.ProgressDialog.OnRunWorkerCompleted(System.ComponentModel.RunWorkerCompletedEventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.ProgressDialog.RunWorkerCompleted"/> event.
+ </summary>
+ <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.ProgressDialog.OnProgressChanged(System.ComponentModel.ProgressChangedEventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.ProgressDialog.ProgressChanged"/> event.
+ </summary>
+ <param name="e">The <see cref="T:System.ComponentModel.ProgressChangedEventArgs"/> containing data for the event.</param>
+ </member>
+ <member name="E:Ookii.Dialogs.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.ProgressDialog.RunWorkerCompleted">
+ <summary>
+ Event raised when the operation completes.
+ </summary>
+ </member>
+ <member name="E:Ookii.Dialogs.ProgressDialog.ProgressChanged">
+ <summary>
+ Event raised when <see cref="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String,System.Object)"/> is called.
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.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.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> is called. Changing property has
+ no effect while the dialog is being displayed.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.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.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)"/> method.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.ProgressDialog.UseCompactPathsForText">
+ <summary>
+ Gets or sets a value that indicates whether path strings in the <see cref="P:Ookii.Dialogs.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.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.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.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)"/> method.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.ProgressDialog.UseCompactPathsForDescription">
+ <summary>
+ Gets or sets a value that indicates whether path strings in the <see cref="P:Ookii.Dialogs.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.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.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> is called. Changing property has
+ no effect while the dialog is being displayed.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.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.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> is called. Changing property has
+ no effect while the dialog is being displayed.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.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.ProgressDialog.DoWork"/> event must periodically check the value of the
+ <see cref="P:Ookii.Dialogs.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.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.ProgressDialog.Show"/> method.
+ </note>
+ <para>
+ This property must be set before <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> is called. Changing property has
+ no effect while the dialog is being displayed.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.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.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.ProgressDialog.Animation">
+ <summary>
+ Gets or sets the animation to show on the progress dialog.
+ </summary>
+ <value>
+ An instance of <see cref="T:Ookii.Dialogs.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.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> is called. Changing property has
+ no effect while the dialog is being displayed.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.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.ProgressBarStyle"/>.
+ The default value is <see cref="F:Ookii.Dialogs.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.ProgressBarStyle.MarqueeProgressBar"/>.
+ </note>
+ <para>
+ When this property is set to <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>, use the <see cref="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32)"/> method to set
+ the value of the progress bar. When this property is set to <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>
+ you can still use the <see cref="M:Ookii.Dialogs.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.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> is called. Changing property has
+ no effect while the dialog is being displayed.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.ProgressDialog.IsBusy">
+ <summary>
+ Gets a value that indicates whether the <see cref="T:Ookii.Dialogs.ProgressDialog"/> is running an asynchronous operation.
+ </summary>
+ <value>
+ <see langword="true"/> if the <see cref="T:Ookii.Dialogs.ProgressDialog"/> is running an asynchronous operation;
+ otherwise, <see langword="false"/>.
+ </value>
+ </member>
+ <member name="T:Ookii.Dialogs.AdditionalVisualStyleElements">
+ <summary>
+ Contains classes that provide additional visual style elements not available through the regular
+ <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> class.
+ </summary>
+ <threadsafety instance="false" static="false"/>
+ </member>
+ <member name="T:Ookii.Dialogs.AdditionalVisualStyleElements.TextStyle">
+ <summary>
+ Provides <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> objects for
+ text styles.
+ </summary>
+ <remarks>
+ <note>
+ Use of these styles requires Windows Vista or a newer version of Windows.
+ </note>
+ </remarks>
+ <threadsafety instance="false" static="false"/>
+ </member>
+ <member name="P:Ookii.Dialogs.AdditionalVisualStyleElements.TextStyle.MainInstruction">
+ <summary>
+ Gets a visual style element that represents the main instruction in a dialog box.
+ </summary>
+ <value>
+ A <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> representing the style for the main instruction.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.AdditionalVisualStyleElements.TextStyle.BodyText">
+ <summary>
+ Gets a visual style element that represents the body text in a dialog box.
+ </summary>
+ <value>
+ A <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> representing the style for the body text.
+ </value>
+ </member>
+ <member name="T:Ookii.Dialogs.AdditionalVisualStyleElements.TaskDialog">
+ <summary>
+ Provides <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> objects
+ for task dialog related elements.
+ </summary>
+ <remarks>
+ <note>
+ Use of these styles requires Windows Vista or a newer version of Windows.
+ </note>
+ </remarks>
+ <threadsafety instance="false" static="false"/>
+ </member>
+ <member name="P:Ookii.Dialogs.AdditionalVisualStyleElements.TaskDialog.PrimaryPanel">
+ <summary>
+ Gets a visual style element that represents the primary panel of a task dialog.
+ </summary>
+ <value>
+ A <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> representing the style for the primary panel.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.AdditionalVisualStyleElements.TaskDialog.SecondaryPanel">
+ <summary>
+ Gets a visual style element that represents the secondary panel of a task dialog.
+ </summary>
+ <value>
+ A <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> representing the style for the secondary panel.
+ </value>
+ </member>
+ <member name="T:Ookii.Dialogs.TaskDialogItem">
+ <summary>
+ Represents a button or radio button on a task dialog.
+ </summary>
+ <threadsafety instance="false" static="true" />
+ </member>
+ <member name="F:Ookii.Dialogs.TaskDialogItem.components">
+ <summary>
+ Required designer variable.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogItem.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.TaskDialogItem.InitializeComponent">
+ <summary>
+ Required method for Designer support - do not modify
+ the contents of this method with the code editor.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogItem.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> class.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogItem.#ctor(System.ComponentModel.IContainer)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> class with the specified container.
+ </summary>
+ <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> to.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogItem.Click">
+ <summary>
+ Simulates a click on the task dialog item.
+ </summary>
+ <remarks>
+ This method is available only while the task dialog is being displayed. You would typically call
+ it from one of the events fired by the <see cref="T:Ookii.Dialogs.TaskDialog"/> class while the dialog is visible.
+ </remarks>
+ <exception cref="T:System.InvalidOperationException">
+ <para>The task dialog is not being displayed</para>
+ <para>-or-</para>
+ <para>The item has no associated task dialog.</para>
+ </exception>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogItem.UpdateOwner">
+ <summary>
+ Causes a full update of the owner dialog.
+ </summary>
+ <remarks>
+ <para>
+ When this method is called, the owner dialog will be updated to reflect the
+ current state of the object.
+ </para>
+ <para>
+ When the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> has no owner, or the owner is not being
+ displayed, this method has no effect.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialogItem.Owner">
+ <summary>
+ Gets the <see cref="T:Ookii.Dialogs.TaskDialog"/> that owns this <see cref="T:Ookii.Dialogs.TaskDialogItem"/>.
+ </summary>
+ <value>
+ The <see cref="T:Ookii.Dialogs.TaskDialog"/> that owns this <see cref="T:Ookii.Dialogs.TaskDialogItem"/>.
+ </value>
+ <remarks>
+ This property is set automatically when the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> is added
+ to the <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/> or <see cref="P:Ookii.Dialogs.TaskDialog.RadioButtons"/>
+ collection of a <see cref="T:Ookii.Dialogs.TaskDialog"/>.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialogItem.Text">
+ <summary>
+ Gets or sets the text of the item.
+ </summary>
+ <value>
+ The text of the item. The default value is an empty string ("").
+ </value>
+ <remarks>
+ <para>
+ For buttons, this property is ignored if <see cref="P:Ookii.Dialogs.TaskDialogButton.ButtonType"/> is any value other
+ than <see cref="F:Ookii.Dialogs.ButtonType.Custom"/>.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialogItem.Enabled">
+ <summary>
+ Gets or sets a value that indicates whether the item is enabled.
+ </summary>
+ <value>
+ <see langword="true" /> if this item is enabled; otherwise, <see langword="false" />.
+ </value>
+ <remarks>
+ If a button or radio button is not enabled, it will be grayed out and cannot be
+ selected or clicked.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialogItem.Id">
+ <summary>
+ Gets or sets the ID of the item.
+ </summary>
+ <value>
+ The unique identifier of the item.
+ </value>
+ <remarks>
+ <para>
+ The identifier of an item must be unique for the type of item on the task dialog (i.e. no two
+ buttons can have the same id, no two radio buttons can have the same id, but a radio button
+ can have the same id as a button).
+ </para>
+ <para>
+ If this property is zero when the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> is added to the <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/>
+ or <see cref="P:Ookii.Dialogs.TaskDialog.RadioButtons"/> collection of a task dialog, it will automatically be set
+ to the next available id value.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialogItem.ItemCollection">
+ <summary>
+ When implemented in a derived class, gets the item collection on a task dialog that this type of item is
+ part of.
+ </summary>
+ <value>
+ For <see cref="T:Ookii.Dialogs.TaskDialogButton"/> items, the <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/>
+ collection of the <see cref="T:Ookii.Dialogs.TaskDialog"/> instance this item is part of. For <see cref="T:Ookii.Dialogs.TaskDialogRadioButton"/> items, the <see cref="P:Ookii.Dialogs.TaskDialog.RadioButtons"/>
+ collection of the <see cref="T:Ookii.Dialogs.TaskDialog"/> instance this item is part of. If the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> is not
+ currently associated with a <see cref="T:Ookii.Dialogs.TaskDialog"/>, <see langword="null"/>.
+ </value>
+ <remarks>
+ The collection returned by this property is used to determine if there are any items with duplicate IDs.
+ </remarks>
+ </member>
+ <member name="T:Ookii.Dialogs.ProgressBarStyle">
+ <summary>
+ Indicates the type of progress on a task dialog.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ProgressBarStyle.None">
+ <summary>
+ No progress bar is displayed on the dialog.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar">
+ <summary>
+ A regular progress bar is displayed on the dialog.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.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.OkButtonClickedEventArgs">
+ <summary>
+ Provides data for the <see cref="E:Ookii.Dialogs.InputDialog.OkButtonClicked"/> event.
+ </summary>
+ <threadsafety instance="false" static="true"/>
+ </member>
+ <member name="M:Ookii.Dialogs.OkButtonClickedEventArgs.#ctor(System.String,System.Windows.Forms.IWin32Window)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.OkButtonClickedEventArgs"/> class with the specified input text
+ and input box window.
+ </summary>
+ <param name="input">The current value of the input field on the dialog.</param>
+ <param name="inputBoxWindow">The input box window.</param>
+ </member>
+ <member name="P:Ookii.Dialogs.OkButtonClickedEventArgs.Input">
+ <summary>
+ Gets the current value of the input field on the dialog.
+ </summary>
+ <value>
+ The current value of the input field on the dialog.
+ </value>
+ <remarks>
+ The <see cref="P:Ookii.Dialogs.InputDialog.Input"/> property will not be updated until the dialog has been closed,
+ so this property can be used to determine the value entered by the user when this event is raised.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.OkButtonClickedEventArgs.InputBoxWindow">
+ <summary>
+ Gets the input box window.
+ </summary>
+ <value>
+ The <see cref="T:System.Windows.Forms.IWin32Window"/> for the input box window.
+ </value>
+ <remarks>
+ You can use this property if you need to display a modal dialog (for example to alert the user if the current input value
+ is invalid) and you want the input box to be the parent of that dialog.
+ </remarks>
+ </member>
+ <member name="T:Ookii.Dialogs.InputDialog">
+ <summary>
+ Represents a dialog that allows the user to input a single text value.
+ </summary>
+ <remarks>
+ Using a modal dialog to ask the user for input is not often the best design decision. Carefully
+ evaluate alternative methods, such as in-place editing, if applicable, before using this dialog.
+ </remarks>
+ <threadsafety instance="false" static="true" />
+ </member>
+ <member name="M:Ookii.Dialogs.InputDialog.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.InputDialog"/> class.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.InputDialog.#ctor(System.ComponentModel.IContainer)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.InputDialog"/> class, adding it to the specified container.
+ </summary>
+ <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the component to.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.InputDialog.OnInputChanged(System.EventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.InputDialog.InputChanged"/> event.
+ </summary>
+ <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.InputDialog.OnOkButtonClicked(Ookii.Dialogs.OkButtonClickedEventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.InputDialog.OkButtonClicked"/> event.
+ </summary>
+ <param name="e">The <see cref="T:Ookii.Dialogs.OkButtonClickedEventArgs"/> containing data for the event.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.InputDialog.ShowDialog">
+ <summary>
+ Displays the input box as a modal dialog box.
+ </summary>
+ <returns>The <see cref="T:System.Windows.Forms.DialogResult"/> value that corresponds to the button the user clicked.</returns>
+ </member>
+ <member name="M:Ookii.Dialogs.InputDialog.ShowDialog(System.Windows.Forms.IWin32Window)">
+ <summary>
+ Displays the input box as a modal dialog box with the specified owner.
+ </summary>
+ <param name="owner">The <see cref="T:System.Windows.Forms.IWin32Window"/> that will be the owner of the dialog box.</param>
+ <returns>The <see cref="T:System.Windows.Forms.DialogResult"/></returns>
+ </member>
+ <member name="F:Ookii.Dialogs.InputDialog.components">
+ <summary>
+ Required designer variable.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.InputDialog.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.InputDialog.InitializeComponent">
+ <summary>
+ Required method for Designer support - do not modify
+ the contents of this method with the code editor.
+ </summary>
+ </member>
+ <member name="E:Ookii.Dialogs.InputDialog.InputChanged">
+ <summary>
+ Event raised when the value of the <see cref="P:Ookii.Dialogs.InputDialog.Input"/> property changes.
+ </summary>
+ <remarks>
+ The value of the <see cref="P:Ookii.Dialogs.InputDialog.Input"/> property is updated only when the user clicks OK and the dialog is closed, not while
+ the user is using the dialog.
+ </remarks>
+ </member>
+ <member name="E:Ookii.Dialogs.InputDialog.OkButtonClicked">
+ <summary>
+ Event raised when the user clicks the OK button on the dialog.
+ </summary>
+ <remarks>
+ Set the <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> property to <see langword="true"/> to prevent the dialog from closing.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.InputDialog.MainInstruction">
+ <summary>
+ Gets or sets the dialog's main instruction.
+ </summary>
+ <value>
+ The dialog's main instruction. The default value is an empty string ("").
+ </value>
+ <remarks>
+ When running on Windows Vista or newer, the main instruction of the input dialog will be displayed in a larger font and a different color than
+ the other text of the input dialog. Otherwise, it will be shown in bold.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.InputDialog.Content">
+ <summary>
+ Gets or sets the dialog's primary content.
+ </summary>
+ <value>
+ The dialog's primary content. The default value is an empty string ("").
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.InputDialog.WindowTitle">
+ <summary>
+ Gets or sets the window title of the dialog.
+ </summary>
+ <value>
+ The window title of the dialog. The default is an empty string ("").
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.InputDialog.Input">
+ <summary>
+ Gets or sets the text specified by the user.
+ </summary>
+ <value>
+ The initial text of the input field, or the text specified by the user. The default vaue is an empty string ("").
+ </value>
+ <remarks>
+ Setting this property before calling <see cref="M:Ookii.Dialogs.InputDialog.ShowDialog"/> determines the initial text in the input field. Retrieving
+ the property after the user has clicked OK will return the text entered by the user.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.InputDialog.MaxLength">
+ <summary>
+ Gets or sets the maximum number of characters that can be entered into the input field of the dialog.
+ </summary>
+ <value>
+ The number of characters that can be entered into the input field. The default value is 32767.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.InputDialog.UsePasswordMasking">
+ <summary>
+ Gets or sets a value that indicates whether the input will be masked using the system password character.
+ </summary>
+ <value>
+ <see langword="true" /> if the input is masked; otherwise, <see langword="false" />. The default value is <see langword="false" />.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.InputDialog.BindingContext">
+ <summary>
+ Gets or sets the collection of currency managers for the <see cref="T:Ookii.Dialogs.InputDialog"/>.
+ </summary>
+ <value>
+ The collection of currency managers for the <see cref="T:Ookii.Dialogs.TaskDialog"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.InputDialog.DataBindings">
+ <summary>
+ Gets the collection of data-binding objects for this <see cref="T:Ookii.Dialogs.InputDialog"/>.
+ </summary>
+ <value>
+ The collection of data-binding objects for this <see cref="T:Ookii.Dialogs.TaskDialog"/>.
+ </value>
+ </member>
+ <member name="T:Ookii.Dialogs.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.CredentialException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialException"/> class.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.CredentialException.#ctor(System.Int32)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.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.CredentialException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialException"/> class with a specified error message.
+ </summary>
+ <param name="message">The message that describes the error.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.CredentialException.#ctor(System.Int32,System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.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.CredentialException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.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.CredentialException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.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.VistaOpenFileDialog">
+ <summary>
+ Prompts the user to open a file.
+ </summary>
+ <remarks>
+ <para>
+ This class will use the Vista style file dialog if possible, and automatically fall back to the old-style
+ dialog on versions of Windows older than Vista.
+ </para>
+ <para>
+ As of .Net 3.5 and .Net 2.0 SP1, the regular <see cref="T:System.Windows.Forms.OpenFileDialog"/> class will also use
+ the new Vista style dialogs. However, certain options, such as settings <see cref="P:System.Windows.Forms.OpenFileDialog.ShowReadOnly"/>,
+ still cause that class to revert to the old style dialogs. For this reason, this class is still provided.
+ It is recommended that you use the <see cref="T:System.Windows.Forms.FileDialog"/> class whenever possible.
+ </para>
+ </remarks>
+ <threadsafety static="true" instance="false"/>
+ </member>
+ <member name="T:Ookii.Dialogs.VistaFileDialog">
+ <summary>
+ Displays a dialog box from which the user can select a file.
+ </summary>
+ <remarks>
+ <para>
+ This class will use the Vista style file dialog if possible, and automatically fall back to the old-style
+ dialog on versions of Windows older than Vista.
+ </para>
+ <para>
+ As of .Net 3.5 and .Net 2.0 SP1, the regular <see cref="T:System.Windows.Forms.FileDialog"/> class will also use
+ the new Vista style dialogs. However, certain options, such as settings <see cref="P:System.Windows.Forms.OpenFileDialog.ShowReadOnly"/>,
+ still cause that class to revert to the old style dialogs. For this reason, this class is still provided.
+ It is recommended that you use the <see cref="T:System.Windows.Forms.FileDialog"/> class whenever possible.
+ </para>
+ </remarks>
+ <threadsafety static="true" instance="false"/>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaFileDialog.#ctor">
+ <summary>
+ Creates a new insatnce of <see cref="T:Ookii.Dialogs.VistaFileDialog"/> class.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaFileDialog.Reset">
+ <summary>
+ Resets all properties to their default values.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaFileDialog.RunDialog(System.IntPtr)">
+ <summary>
+ Specifies a common dialog box.
+ </summary>
+ <param name="hwndOwner">A value that represents the window handle of the owner window for the common dialog box.</param>
+ <returns><see langword="true"/> if the file could be opened; otherwise, <see langword="false"/>.</returns>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaFileDialog.OnFileOk(System.ComponentModel.CancelEventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.VistaFileDialog.FileOk"/> event.
+ </summary>
+ <param name="e">A <see cref="T:System.ComponentModel.CancelEventArgs"/> that contains the event data.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaFileDialog.Dispose(System.Boolean)">
+ <summary>
+ Releases the unmanaged resources used by the <see cref="T:Ookii.Dialogs.VistaFileDialog"/> and optionally releases the managed resources.
+ </summary>
+ <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
+ </member>
+ <member name="E:Ookii.Dialogs.VistaFileDialog.FileOk">
+ <summary>
+ Occurs when the user clicks on the Open or Save button on a file dialog box.
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.IsVistaFileDialogSupported">
+ <summary>
+ Gets a value that indicates whether the current OS supports Vista-style common file dialogs.
+ </summary>
+ <value>
+ <see langword="true"/> on Windows Vista or newer operating systems; otherwise, <see langword="false"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.AddExtension">
+ <summary>
+ Gets or sets a value indicating whether the dialog box automatically adds an extension to a file name
+ if the user omits the extension.
+ </summary>
+ <value>
+ <see langword="true"/> if the dialog box adds an extension to a file name if the user omits the extension; otherwise, <see langword="false"/>.
+ The default value is <see langword="true"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.CheckFileExists">
+ <summary>
+ Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.
+ </summary>
+ <value>
+ <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="false"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.CheckPathExists">
+ <summary>
+ Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a path that does not exist.
+ </summary>
+ <value>
+ <see langword="true"/> if the dialog box displays a warning when the user specifies a path that does not exist; otherwise, <see langword="false"/>.
+ The default value is <see langword="true"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.DefaultExt">
+ <summary>
+ Gets or sets the default file name extension.
+ </summary>
+ <value>
+ The default file name extension. The returned string does not include the period. The default value is an empty string ("").
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.DereferenceLinks">
+ <summary>
+ Gets or sets a value indicating whether the dialog box returns the location of the file referenced by the shortcut
+ or whether it returns the location of the shortcut (.lnk).
+ </summary>
+ <value>
+ <see langword="true"/> if the dialog box returns the location of the file referenced by the shortcut; otherwise, <see langword="false"/>.
+ The default value is <see langword="true"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.FileName">
+ <summary>
+ Gets or sets a string containing the file name selected in the file dialog box.
+ </summary>
+ <value>
+ The file name selected in the file dialog box. The default value is an empty string ("").
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.FileNames">
+ <summary>
+ Gets the file names of all selected files in the dialog box.
+ </summary>
+ <value>
+ An array of type String, containing the file names of all selected files in the dialog box.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.Filter">
+ <summary>
+ Gets or sets the current file name filter string, which determines the choices that appear in the
+ "Save as file type" or "Files of type" box in the dialog box.
+ </summary>
+ <value>
+ The file filtering options available in the dialog box.
+ </value>
+ <exception cref="T:System.ArgumentException">Filter format is invalid.</exception>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.FilterIndex">
+ <summary>
+ Gets or sets the index of the filter currently selected in the file dialog box.
+ </summary>
+ <value>
+ A value containing the index of the filter currently selected in the file dialog box. The default value is 1.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.InitialDirectory">
+ <summary>
+ Gets or sets the initial directory displayed by the file dialog box.
+ </summary>
+ <value>
+ The initial directory displayed by the file dialog box. The default is an empty string ("").
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.RestoreDirectory">
+ <summary>
+ Gets or sets a value indicating whether the dialog box restores the current directory before closing.
+ </summary>
+ <value>
+ <see langword="true"/> if the dialog box restores the current directory to its original value if the user changed the
+ directory while searching for files; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.ShowHelp">
+ <summary>
+ Gets or sets a value indicating whether the Help button is displayed in the file dialog box.
+ </summary>
+ <value>
+ <see langword="true"/> if the dialog box includes a help button; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.Title">
+ <summary>
+ Gets or sets the file dialog box title.
+ </summary>
+ <value>
+ The file dialog box title. The default value is an empty string ("").
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.SupportMultiDottedExtensions">
+ <summary>
+ Gets or sets whether the dialog box supports displaying and saving files that have multiple file name extensions.
+ </summary>
+ <value>
+ <see langword="true"/> if the dialog box supports multiple file name extensions; otherwise, <see langword="false"/>. The default is <see langword="false"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.ValidateNames">
+ <summary>
+ Gets or sets a value indicating whether the dialog box accepts only valid Win32 file names.
+ </summary>
+ <value>
+ <see langword="true"/> if the dialog box accepts only valid Win32 file names; otherwise, <see langword="false"/>. The default value is <see langword="true"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFileDialog.DownlevelDialog">
+ <summary>
+ Gets or sets the downlevel file dialog which is to be used if the Vista-style
+ dialog is not supported.
+ </summary>
+ <value>
+ The downlevel file dialog which is to be used if the Vista-style
+ dialog is not supported.
+ </value>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaOpenFileDialog.#ctor">
+ <summary>
+ Creates a new instance of <see cref="T:Ookii.Dialogs.VistaOpenFileDialog"/> class.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaOpenFileDialog.#ctor(System.Boolean)">
+ <summary>
+ Creates a new instance of <see cref="T:Ookii.Dialogs.VistaOpenFileDialog"/> class.
+ </summary>
+ <param name="forceDownlevel">When <see langword="true"/>, the old style common file dialog will always be used even if the OS supports the Vista style.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaOpenFileDialog.Reset">
+ <summary>
+ Resets all properties to their default values.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaOpenFileDialog.OpenFile">
+ <summary>
+ Opens the file selected by the user, with read-only permission. The file is specified by the FileName property.
+ </summary>
+ <returns>A Stream that specifies the read-only file selected by the user.</returns>
+ <exception cref="T:System.ArgumentNullException">The file name is <see langword="null"/>.</exception>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaOpenFileDialog.CheckFileExists">
+ <summary>
+ Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.
+ </summary>
+ <value>
+ <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"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaOpenFileDialog.Multiselect">
+ <summary>
+ Gets or sets a value indicating whether the dialog box allows multiple files to be selected.
+ </summary>
+ <value>
+ <see langword="true"/> if the dialog box allows multiple files to be selected together or concurrently; otherwise, <see langword="false"/>.
+ The default value is <see langword="false"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaOpenFileDialog.ShowReadOnly">
+ <summary>
+ Gets or sets a value indicating whether the dialog box contains a read-only check box.
+ </summary>
+ <value>
+ <see langword="true"/> if the dialog box contains a read-only check box; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
+ </value>
+ <remarks>
+ If the Vista style dialog is used, this property can only be used to determine whether the user chose
+ Open as read-only on the dialog; setting it in code will have no effect.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaOpenFileDialog.ReadOnlyChecked">
+ <summary>
+ Gets or sets a value indicating whether the read-only check box is selected.
+ </summary>
+ <value>
+ <see langword="true"/> if the read-only check box is selected; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
+ </value>
+ </member>
+ <member name="T:Ookii.Dialogs.TimerEventArgs">
+ <summary>
+ Provides data for the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event.
+ </summary>
+ <threadsafety instance="false" static="true"/>
+ </member>
+ <member name="M:Ookii.Dialogs.TimerEventArgs.#ctor(System.Int32)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TimerEventArgs"/> class with the specified tick count.
+ </summary>
+ <param name="tickCount">The tick count.</param>
+ </member>
+ <member name="P:Ookii.Dialogs.TimerEventArgs.ResetTickCount">
+ <summary>
+ Gets or sets a value that indicates whether the tick count should be reset.
+ </summary>
+ <value>
+ <see langword="true" /> to reset the tick count after the event handler returns; otherwise, <see langword="false" />.
+ The default value is <see langword="false" />.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.TimerEventArgs.TickCount">
+ <summary>
+ Gets the current tick count of the timer.
+ </summary>
+ <value>
+ The number of milliseconds that has elapsed since the dialog was created or since the last time the event handler returned
+ with the <see cref="P:Ookii.Dialogs.TimerEventArgs.ResetTickCount"/> property set to <see langword="true"/>.
+ </value>
+ </member>
+ <member name="T:Ookii.Dialogs.TaskDialogItemClickedEventArgs">
+ <summary>
+ Provides data for the <see cref="E:Ookii.Dialogs.TaskDialog.ButtonClicked"/> event.
+ </summary>
+ <threadsafety instance="false" static="true"/>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogItemClickedEventArgs.#ctor(Ookii.Dialogs.TaskDialogItem)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogItemClickedEventArgs"/> class with the specified item.
+ </summary>
+ <param name="item">The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> that was clicked.</param>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialogItemClickedEventArgs.Item">
+ <summary>
+ Gets the item that was clicked.
+ </summary>
+ <value>
+ The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> that was clicked.
+ </value>
+ </member>
+ <member name="T:Ookii.Dialogs.TaskDialogButton">
+ <summary>
+ A button on a <see cref="T:Ookii.Dialogs.TaskDialog"/>.
+ </summary>
+ <threadsafety instance="false" static="true"/>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogButton.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> class.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogButton.#ctor(Ookii.Dialogs.ButtonType)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> class with the specified button type.
+ </summary>
+ <param name="type">The type of the button.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogButton.#ctor(System.ComponentModel.IContainer)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> class with the specified container.
+ </summary>
+ <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> to.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogButton.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> class with the specified text.
+ </summary>
+ <param name="text">The text of the button.</param>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialogButton.ButtonType">
+ <summary>
+ Gets or sets the type of the button.
+ </summary>
+ <value>
+ One of the <see cref="T:Ookii.Dialogs.ButtonType"/> values that indicates the type of the button. The default value
+ is <see cref="F:Ookii.Dialogs.ButtonType.Custom"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialogButton.CommandLinkNote">
+ <summary>
+ Gets or sets the text of the note associated with a command link button.
+ </summary>
+ <value>
+ The text of the note associated with a command link button.
+ </value>
+ <remarks>
+ <para>
+ This property applies only to buttons where the <see cref="T:System.Type"/> property
+ is <see cref="F:Ookii.Dialogs.ButtonType.Custom"/>. For other button types, it is ignored.
+ </para>
+ <para>
+ In addition, it is used only if the <see cref="P:Ookii.Dialogs.TaskDialog.ButtonStyle"/> property is set to
+ <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinks"/> or <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinksNoIcon"/>;
+ otherwise, it is ignored.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialogButton.Default">
+ <summary>
+ Gets or sets a value that indicates if the button is the default button on the dialog.
+ </summary>
+ <value><see langword="true" /> if the button is the default button; otherwise, <see langword="false" />.
+ The default value is <see langword="false" />.</value>
+ <remarks>
+ If no button has this property set to <see langword="true" />, the first button on the dialog will be the default button.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialogButton.ElevationRequired">
+ <summary>
+ Gets or sets a value that indicates whether the Task Dialog button or command link should have a
+ User Account Control (UAC) shield icon (in other words, whether the action invoked by the
+ button requires elevation).
+ </summary>
+ <value>
+ <see langword="true" /> if the button contains a UAC shield icon; otherwise, <see langword="false" />.
+ </value>
+ <remarks>
+ Elevation is not performed by the task dialog; the code implementing the operation that results from
+ the button being clicked is responsible for performing elevation if required.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialogButton.ItemCollection">
+ <summary>
+ Gets the collection that items of this type are part of.
+ </summary>
+ <value>
+ If the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> is currently associated with a <see cref="T:Ookii.Dialogs.TaskDialog"/>, the
+ <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/> collection of that <see cref="T:Ookii.Dialogs.TaskDialog"/>; otherwise, <see langword="null"/>.
+ </value>
+ </member>
+ <member name="T:Ookii.Dialogs.Properties.Resources">
+ <summary>
+ A strongly-typed resource class, for looking up localized strings, etc.
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.ResourceManager">
+ <summary>
+ Returns the cached ResourceManager instance used by this class.
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.Culture">
+ <summary>
+ Overrides the current thread's CurrentUICulture property for all
+ resource lookups using this strongly typed resource class.
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.AnimationLoadErrorFormat">
+ <summary>
+ Looks up a localized string similar to Unable to load the progress dialog animation: {0}.
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.CredentialEmptyTargetError">
+ <summary>
+ Looks up a localized string similar to The credential target may not be an empty string..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.CredentialError">
+ <summary>
+ Looks up a localized string similar to An error occurred acquiring credentials..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.CredentialPromptNotCalled">
+ <summary>
+ Looks up a localized string similar to PromptForCredentialsWithSave has not been called or the credentials were modified after the call..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.DuplicateButtonTypeError">
+ <summary>
+ Looks up a localized string similar to The task dialog already has a non-custom button with the same type..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.DuplicateItemIdError">
+ <summary>
+ Looks up a localized string similar to The task dialog already has an item with the same id..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.FileNotFoundFormat">
+ <summary>
+ Looks up a localized string similar to The file "{0}" could not be found..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.GlassNotSupportedError">
+ <summary>
+ Looks up a localized string similar to The current operating system does not support glass, or the Desktop Window Manager is not enabled..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.Help">
+ <summary>
+ Looks up a localized string similar to Help.
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.InvalidFilterString">
+ <summary>
+ Looks up a localized string similar to Invalid filter string,.
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.InvalidTaskDialogItemIdError">
+ <summary>
+ Looks up a localized string similar to The id of a task dialog item must be higher than 0..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.NoAssociatedTaskDialogError">
+ <summary>
+ Looks up a localized string similar to The item is not associated with a task dialog..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.NonCustomTaskDialogButtonIdError">
+ <summary>
+ Looks up a localized string similar to Cannot change the id for a standard button..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.Preview">
+ <summary>
+ Looks up a localized string similar to Preview.
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.ProgressDialogNotRunningError">
+ <summary>
+ Looks up a localized string similar to The progress dialog is not shown..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.ProgressDialogRunning">
+ <summary>
+ Looks up a localized string similar to The progress dialog is already running..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogEmptyButtonLabelError">
+ <summary>
+ Looks up a localized string similar to A custom button or radio button cannot have an empty label..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogIllegalCrossThreadCallError">
+ <summary>
+ 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..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogItemHasOwnerError">
+ <summary>
+ Looks up a localized string similar to The task dialog item already belongs to another task dialog..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogNoButtonsError">
+ <summary>
+ Looks up a localized string similar to The task dialog must have buttons..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogNotRunningError">
+ <summary>
+ Looks up a localized string similar to The task dialog is not current displayed..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogRunningError">
+ <summary>
+ Looks up a localized string similar to The task dialog is already being displayed..
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogsNotSupportedError">
+ <summary>
+ Looks up a localized string similar to The operating system does not support task dialogs..
+ </summary>
+ </member>
+ <member name="T:Ookii.Dialogs.Glass">
+ <summary>
+ Provides functionality to use Aero Glass.
+ </summary>
+ <remarks>
+ <para>
+ This class provides functionality to extend the Windows Vista Aero glass window frame into a window's
+ client area, and to draw text on the glass area.
+ </para>
+ <para>
+ The <see cref="T:Ookii.Dialogs.ExtendedForm"/> class provides more comprehensive support for client area glass than
+ using <see cref="M:Ookii.Dialogs.Glass.ExtendFrameIntoClientArea(System.Windows.Forms.IWin32Window,System.Windows.Forms.Padding)"/> by using its <see cref="P:Ookii.Dialogs.ExtendedForm.GlassMargin"/> property.
+ In addition to the basic client area glass support, <see cref="T:Ookii.Dialogs.ExtendedForm"/> will also
+ respond to changes in the Desktop Window Manager state and enable/disable client area glass as necessary. It also
+ allows the window to be dragged using the client area glass areas using the <see cref="P:Ookii.Dialogs.ExtendedForm.AllowGlassDragging"/>
+ property.
+ </para>
+ <note>
+ Use of glass requires Windows Vista or later with the Desktop Window Manager enabled.
+ </note>
+ </remarks>
+ <threadsafety instance="false" static="true"/>
+ </member>
+ <member name="M:Ookii.Dialogs.Glass.ExtendFrameIntoClientArea(System.Windows.Forms.IWin32Window,System.Windows.Forms.Padding)">
+ <summary>
+ Extends the glass window frame into the client area of the specified window.
+ </summary>
+ <param name="window">The <see cref="T:System.Windows.Forms.IWin32Window"/> on which to enable client area glass.</param>
+ <param name="glassMargin">The the margins to use when extending the frame into the client area.</param>
+ <remarks>
+ <para>
+ Use negative margins to create the "sheet of glass" effect where the client area is rendered
+ as a completely glass surface.
+ </para>
+ <para>
+ The glass area must be filled with either a black brush or the <see cref="P:System.Windows.Forms.Form.TransparencyKey"/> color
+ in order to display correctly. If the <see cref="P:System.Windows.Forms.Form.TransparencyKey"/> method is used, clicks in the
+ glass area will "fall through" the window to the window below it. If the black brush method is used, text
+ rendered with the <see cref="T:System.Windows.Forms.TextRenderer"/> will not display correctly on the glass area (this includes
+ text drawn by most controls). To draw text on the glass area, use <see cref="M:Ookii.Dialogs.Glass.DrawCompositedText(System.Drawing.IDeviceContext,System.String,System.Drawing.Font,System.Drawing.Rectangle,System.Windows.Forms.Padding,System.Drawing.Color,System.Int32,System.Windows.Forms.TextFormatFlags)"/>.
+ </para>
+ <para>
+ This method needs to be called again if the state of the Desktop Window Manager is toggled.
+ </para>
+ </remarks>
+ <exception cref="T:System.ArgumentNullException"><paramref name="window"/> is <see langword="null"/>.</exception>
+ <exception cref="T:System.NotSupportedException">The current operating system does not support glass, or the Desktop Window Manager is not enabled.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.Glass.DrawCompositedText(System.Drawing.IDeviceContext,System.String,System.Drawing.Font,System.Drawing.Rectangle,System.Windows.Forms.Padding,System.Drawing.Color,System.Int32,System.Windows.Forms.TextFormatFlags)">
+ <summary>
+ Draws composited text onto the glass area of a form.
+ </summary>
+ <param name="dc">The <see cref="T:System.Drawing.IDeviceContext"/> onto which the composited text should be drawn.</param>
+ <param name="text">The text to draw.</param>
+ <param name="font">The <see cref="T:System.Drawing.Font"/> to apply to the drawn text.</param>
+ <param name="bounds">The <see cref="T:System.Drawing.Rectangle"/> that represents the bounds of the text.</param>
+ <param name="padding">The <see cref="T:System.Windows.Forms.Padding"/> around the text; necessary to allow space for the glow effect.</param>
+ <param name="foreColor">The <see cref="T:System.Drawing.Color"/> to apply to the drawn text.</param>
+ <param name="textFormat">A bitwise combination of the <see cref="T:System.Windows.Forms.TextFormatFlags"/> values.</param>
+ <param name="glowSize">Specifies the size of a glow that will be drawn on the background prior to any text being drawn.</param>
+ <remarks>
+ <para>
+ Do not use this method to draw text on non-glass areas of a form.
+ </para>
+ </remarks>
+ <exception cref="T:System.NotSupportedException">The current operating system does not support glass, or the Desktop Window Manager is not enabled.</exception>
+ <exception cref="T:System.ArgumentNullException"><paramref name="dc"/>, <paramref name="text"/> or <paramref name="font"/> is <see langword="null"/>.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.Glass.MeasureCompositedText(System.Drawing.IDeviceContext,System.String,System.Drawing.Font,System.Windows.Forms.TextFormatFlags)">
+ <summary>
+ Provides the size, in pixels, of the specified text.
+ </summary>
+ <param name="dc">The device context in which to measure the text.</param>
+ <param name="text">The text to measure.</param>
+ <param name="font">The <see cref="T:System.Drawing.Font"/> to apply to the measured text.</param>
+ <param name="textFormat">A bitwise combination of the <see cref="T:System.Windows.Forms.TextFormatFlags"/> values.</param>
+ <returns>The <see cref="T:System.Drawing.Size"/>, in pixels, of <paramref name="text"/> drawn with the specified <paramref name="font"/> and format.</returns>
+ <exception cref="T:System.NotSupportedException">The current operating system does not support glass, or the Desktop Window Manager is not enabled.</exception>
+ <exception cref="T:System.ArgumentNullException"><paramref name="dc"/>, <paramref name="text"/> or <paramref name="font"/> is <see langword="null"/>.</exception>
+ </member>
+ <member name="P:Ookii.Dialogs.Glass.OSSupportsDwmComposition">
+ <summary>
+ Gets a value that indicates whether the operating system supports composition through the Desktop Window Manager.
+ </summary>
+ <value>
+ <see langword="true" /> on operating systems that support the Desktop Window Manager (Windows Vista and higher); otherwise, <see langword="false" />.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.Glass.IsDwmCompositionEnabled">
+ <summary>
+ Gets a value that indicates whether desktop composition is enabled.
+ </summary>
+ <value>
+ <see langword="true" /> when desktop composition is supported and enabled; otherwise, <see langword="false" />.
+ </value>
+ </member>
+ <member name="T:Ookii.Dialogs.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.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.CredentialDialog.Target"/> property.
+ </para>
+ <note>
+ This class requires Windows XP or later.
+ </note>
+ </remarks>
+ <threadsafety instance="false" static="true"/>
+ </member>
+ <member name="F:Ookii.Dialogs.CredentialDialog.components">
+ <summary>
+ Required designer variable.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.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.CredentialDialog.InitializeComponent">
+ <summary>
+ Required method for Designer support - do not modify
+ the contents of this method with the code editor.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.CredentialDialog.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialDialog"/> class.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.CredentialDialog.#ctor(System.ComponentModel.IContainer)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.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="M:Ookii.Dialogs.CredentialDialog.ShowDialog">
+ <summary>
+ Shows the credentials dialog as a modal dialog.
+ </summary>
+ <returns><see cref="F:System.Windows.Forms.DialogResult.OK"/> if the user clicked OK; otherwise, <see cref="F:System.Windows.Forms.DialogResult.Cancel"/>.</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.CredentialDialog.UseApplicationInstanceCredentialCache"/> is <see langword="true"/> and the application instance
+ credential cache contains credentials for the specified <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/>, even if <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/>
+ is <see langword="true"/>.
+ </description>
+ </item>
+ <item>
+ <description>
+ <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> is <see langword="true"/>, <see cref="P:Ookii.Dialogs.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.CredentialDialog.Target"/>.
+ </description>
+ </item>
+ </list>
+ <para>
+ In these cases, the <see cref="P:Ookii.Dialogs.CredentialDialog.Credentials"/>, <see cref="P:Ookii.Dialogs.CredentialDialog.UserName"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Password"/> properties will
+ be set to the saved credentials and this function returns immediately, returning <see cref="F:System.Windows.Forms.DialogResult.OK"/>.
+ </para>
+ <para>
+ If the <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> property is <see langword="true"/>, you should call <see cref="M:Ookii.Dialogs.CredentialDialog.ConfirmCredentials(System.Boolean)"/>
+ after validating if the provided credentials are correct.
+ </para>
+ </remarks>
+ <exception cref="T:Ookii.Dialogs.CredentialException">An error occurred while showing the credentials dialog.</exception>
+ <exception cref="T:System.InvalidOperationException"><see cref="P:Ookii.Dialogs.CredentialDialog.Target"/> is an empty string ("").</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.CredentialDialog.ShowDialog(System.Windows.Forms.IWin32Window)">
+ <summary>
+ Shows the credentials dialog as a modal dialog with the specified owner.
+ </summary>
+ <param name="owner">The <see cref="T:System.Windows.Forms.IWin32Window"/> that owns the credentials dialog.</param>
+ <returns><see cref="F:System.Windows.Forms.DialogResult.OK"/> if the user clicked OK; otherwise, <see cref="F:System.Windows.Forms.DialogResult.Cancel"/>.</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.CredentialDialog.UseApplicationInstanceCredentialCache"/> is <see langword="true"/> and the application instance
+ credential cache contains credentials for the specified <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/>, even if <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/>
+ is <see langword="true"/>.
+ </description>
+ </item>
+ <item>
+ <description>
+ <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> is <see langword="true"/>, <see cref="P:Ookii.Dialogs.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.CredentialDialog.Target"/>.
+ </description>
+ </item>
+ </list>
+ <para>
+ In these cases, the <see cref="P:Ookii.Dialogs.CredentialDialog.Credentials"/>, <see cref="P:Ookii.Dialogs.CredentialDialog.UserName"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Password"/> properties will
+ be set to the saved credentials and this function returns immediately, returning <see cref="F:System.Windows.Forms.DialogResult.OK"/>.
+ </para>
+ <para>
+ If the <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> property is <see langword="true"/>, you should call <see cref="M:Ookii.Dialogs.CredentialDialog.ConfirmCredentials(System.Boolean)"/>
+ after validating if the provided credentials are correct.
+ </para>
+ </remarks>
+ <exception cref="T:Ookii.Dialogs.CredentialException">An error occurred while showing the credentials dialog.</exception>
+ <exception cref="T:System.InvalidOperationException"><see cref="P:Ookii.Dialogs.CredentialDialog.Target"/> is an empty string ("").</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.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.CredentialDialog.ShowDialog"/> when <see cref="P:Ookii.Dialogs.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.CredentialDialog.ShowDialog"/> was not called, or the user did not click OK, or <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> was <see langword="false"/>
+ at the call, or the value of <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/> or <see cref="P:Ookii.Dialogs.CredentialDialog.IsSaveChecked"/>
+ was changed after the call.</exception>
+ <exception cref="T:Ookii.Dialogs.CredentialException">There was an error saving the credentials.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.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.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.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.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.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.CredentialException">An error occurred retrieving the credentials.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.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.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.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.CredentialException">An error occurred deleting the credentials from the operating system's credential store.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.CredentialDialog.OnUserNameChanged(System.EventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.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.CredentialDialog.OnPasswordChanged(System.EventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.CredentialDialog.PasswordChanged"/> event.
+ </summary>
+ <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>
+ </member>
+ <member name="E:Ookii.Dialogs.CredentialDialog.UserNameChanged">
+ <summary>
+ Event raised when the <see cref="P:Ookii.Dialogs.CredentialDialog.UserName"/> property changes.
+ </summary>
+ </member>
+ <member name="E:Ookii.Dialogs.CredentialDialog.PasswordChanged">
+ <summary>
+ Event raised when the <see cref="P:Ookii.Dialogs.CredentialDialog.Password"/> property changes.
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.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.CredentialDialog.UseApplicationInstanceCredentialCache"/> property is set to <see langword="true"/>, credentials that
+ are confirmed with <see cref="M:Ookii.Dialogs.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.CredentialDialog.ShowDialog"/> is called, and credentials for the specified <see cref="P:Ookii.Dialogs.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.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.CredentialDialog.ShowUIForSavedCredentials"/>
+ property must be set to <see langword="true"/>.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.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.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.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.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.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.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.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.CredentialDialog.DownlevelTextMode"/>
+ property.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.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.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.CredentialDialog.DownlevelTextMode"/>
+ property.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.CredentialDialog.DownlevelTextMode">
+ <summary>
+ Gets or sets a value that indicates how the text of the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/> properties
+ is displayed on Windows XP.
+ </summary>
+ <value>
+ One of the values of the <see cref="T:Ookii.Dialogs.DownlevelTextMode"/> enumeration. The default value is
+ <see cref="F:Ookii.Dialogs.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.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.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.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.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.CredentialDialog.ConfirmCredentials(System.Boolean)"/> method.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.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.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.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.CredentialDialog.UserName"/>, <see cref="P:Ookii.Dialogs.CredentialDialog.Password"/>,
+ and <see cref="P:Ookii.Dialogs.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.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.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="T:Ookii.Dialogs.VistaSaveFileDialog">
+ <summary>
+ Prompts the user to select a location for saving a file.
+ </summary>
+ <remarks>
+ <para>
+ This class will use the Vista style file dialog if possible, and automatically fall back to the old-style
+ dialog on versions of Windows older than Vista.
+ </para>
+ <para>
+ As of .Net 3.5 and .Net 2.0 SP1, the regular <see cref="T:System.Windows.Forms.FileDialog"/> class will also use
+ the new Vista style dialogs. However, certain options, such as settings <see cref="P:System.Windows.Forms.OpenFileDialog.ShowReadOnly"/>,
+ still cause that class to revert to the old style dialogs. For this reason, this class is still provided.
+ It is recommended that you use the <see cref="T:System.Windows.Forms.SaveFileDialog"/> class whenever possible.
+ </para>
+ </remarks>
+ <threadsafety static="true" instance="false"/>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaSaveFileDialog.#ctor">
+ <summary>
+ Creates a new instance of <see cref="T:Ookii.Dialogs.VistaSaveFileDialog"/> class.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaSaveFileDialog.#ctor(System.Boolean)">
+ <summary>
+ Creates a new instance of <see cref="T:Ookii.Dialogs.VistaSaveFileDialog"/> class.
+ </summary>
+ <param name="forceDownlevel">When <see langword="true"/>, the old style common file dialog will always be used even if the OS supports the Vista style.</param>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaSaveFileDialog.Reset">
+ <summary>
+ Resets all properties to their default values.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaSaveFileDialog.OpenFile">
+ <summary>
+ Opens the file with read/write permission selected by the user.
+ </summary>
+ <returns>The read/write file selected by the user.</returns>
+ <exception cref="T:System.ArgumentNullException"><see cref="P:Ookii.Dialogs.VistaFileDialog.FileName"/> is <see langword="null"/> or an empty string.</exception>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaSaveFileDialog.OnFileOk(System.ComponentModel.CancelEventArgs)">
+ <summary>
+ Raises the <see cref="E:Ookii.Dialogs.VistaFileDialog.FileOk"/> event.
+ </summary>
+ <param name="e">A <see cref="T:System.ComponentModel.CancelEventArgs"/> that contains the event data.</param>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaSaveFileDialog.CreatePrompt">
+ <summary>
+ Gets or sets a value indicating whether the dialog box prompts the user for permission to create a file if the
+ user specifies a file that does not exist.
+ </summary>
+ <value>
+ <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;
+ <see langword="false"/> if the dialog box automatically creates the new file without prompting the user for permission. The default
+ value is <see langword="false"/>.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaSaveFileDialog.OverwritePrompt">
+ <summary>
+ Gets or sets a value indicating whether the Save As dialog box displays a warning if the user
+ specifies a file name that already exists.
+ </summary>
+ <value>
+ <see langword="true"/> if the dialog box prompts the user before overwriting an existing file if the user specifies a file
+ name that already exists; <see langword="false"/> if the dialog box automatically overwrites the existing file without
+ prompting the user for permission. The default value is <see langword="true"/>.
+ </value>
+ </member>
+ <member name="T:Ookii.Dialogs.ButtonType">
+ <summary>
+ Represents the type of a task dialog button.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ButtonType.Custom">
+ <summary>
+ The button is a custom button.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ButtonType.Ok">
+ <summary>
+ The button is the common OK button.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ButtonType.Yes">
+ <summary>
+ The button is the common Yes button.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ButtonType.No">
+ <summary>
+ The button is the common No button.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ButtonType.Cancel">
+ <summary>
+ The button is the common Cancel button.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ButtonType.Retry">
+ <summary>
+ The button is the common Retry button.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.ButtonType.Close">
+ <summary>
+ The button is the common Close button.
+ </summary>
+ </member>
+ <member name="T:Ookii.Dialogs.VistaFolderBrowserDialog">
+ <summary>
+ Prompts the user to select a folder.
+ </summary>
+ <remarks>
+ This class will use the Vista style Select Folder dialog if possible, or the regular FolderBrowserDialog
+ if it is not. Note that the Vista style dialog is very different, so using this class without testing
+ in both Vista and older Windows versions is not recommended.
+ </remarks>
+ <threadsafety instance="false" static="true" />
+ </member>
+ <member name="M:Ookii.Dialogs.VistaFolderBrowserDialog.#ctor">
+ <summary>
+ Creates a new instance of the <see cref="T:Ookii.Dialogs.VistaFolderBrowserDialog"/> class.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaFolderBrowserDialog.Reset">
+ <summary>
+ Resets all properties to their default values.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaFolderBrowserDialog.RunDialog(System.IntPtr)">
+ <summary>
+ Specifies a common dialog box.
+ </summary>
+ <param name="hwndOwner">A value that represents the window handle of the owner window for the common dialog box.</param>
+ <returns><see langword="true" /> if the file could be opened; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="M:Ookii.Dialogs.VistaFolderBrowserDialog.Dispose(System.Boolean)">
+ <summary>
+ Releases the unmanaged resources used by the <see cref="T:Ookii.Dialogs.VistaFolderBrowserDialog"/> and optionally releases the managed resources.
+ </summary>
+ <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
+ </member>
+ <member name="E:Ookii.Dialogs.VistaFolderBrowserDialog.HelpRequest">
+ <summary>
+ Occurs when the user clicks the Help button on the dialog box.
+ </summary>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.IsVistaFolderDialogSupported">
+ <summary>
+ Gets a value that indicates whether the current OS supports Vista-style common file dialogs.
+ </summary>
+ <value>
+ <see langword="true" /> on Windows Vista or newer operating systems; otherwise, <see langword="false" />.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.Description">
+ <summary>
+ Gets or sets the descriptive text displayed above the tree view control in the dialog box, or below the list view control
+ in the Vista style dialog.
+ </summary>
+ <value>
+ The description to display. The default is an empty string ("").
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.RootFolder">
+ <summary>
+ Gets or sets the root folder where the browsing starts from. This property has no effect if the Vista style
+ dialog is used.
+ </summary>
+ <value>
+ One of the <see cref="T:System.Environment.SpecialFolder"/> values. The default is Desktop.
+ </value>
+ <exception cref="T:System.ComponentModel.InvalidEnumArgumentException">The value assigned is not one of the <see cref="T:System.Environment.SpecialFolder"/> values.</exception>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.SelectedPath">
+ <summary>
+ Gets or sets the path selected by the user.
+ </summary>
+ <value>
+ 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 ("").
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.ShowNewFolderButton">
+ <summary>
+ Gets or sets a value indicating whether the New Folder button appears in the folder browser dialog box. This
+ property has no effect if the Vista style dialog is used; in that case, the New Folder button is always shown.
+ </summary>
+ <value>
+ <see langword="true" /> if the New Folder button is shown in the dialog box; otherwise, <see langword="false" />. The default is <see langword="true" />.
+ </value>
+ </member>
+ <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.UseDescriptionForTitle">
+ <summary>
+ Gets or sets a value that indicates whether to use the value of the <see cref="P:Ookii.Dialogs.VistaFolderBrowserDialog.Description"/> property
+ as the dialog title for Vista style dialogs. This property has no effect on old style dialogs.
+ </summary>
+ <value><see langword="true"/> to indicate that the value of the <see cref="P:Ookii.Dialogs.VistaFolderBrowserDialog.Description"/> property is used as dialog title; <see langword="false"/>
+ to indicate the value is added as additional text to the dialog. The default is <see langword="false"/>.</value>
+ </member>
+ <member name="T:Ookii.Dialogs.TaskDialogButtonStyle">
+ <summary>
+ Indicates the display style of custom buttons on a task dialog.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.TaskDialogButtonStyle.Standard">
+ <summary>
+ Custom buttons are displayed as regular buttons.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinks">
+ <summary>
+ Custom buttons are displayed as command links using a standard task dialog glyph.
+ </summary>
+ </member>
+ <member name="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinksNoIcon">
+ <summary>
+ Custom buttons are displayed as command links without a glyph.
+ </summary>
+ </member>
+ <member name="T:Ookii.Dialogs.TaskDialogRadioButton">
+ <summary>
+ A radio button on a task dialog.
+ </summary>
+ <threadsafety static="true" instance="false" />
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogRadioButton.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogRadioButton"/> class.
+ </summary>
+ </member>
+ <member name="M:Ookii.Dialogs.TaskDialogRadioButton.#ctor(System.ComponentModel.IContainer)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogRadioButton"/> class with the specified container.
+ </summary>
+ <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.TaskDialogRadioButton"/> to.</param>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialogRadioButton.Checked">
+ <summary>
+ Gets or sets a value that indicates whether the radio button is checked.
+ </summary>
+ <value>
+ <see langword="true"/> if the radio button is checked; otherwise, <see langword="false"/>.
+ The default value is <see langword="false"/>.
+ </value>
+ <remarks>
+ Setting this property while the dialog is being displayed has no effect. Instead, use the <see cref="M:Ookii.Dialogs.TaskDialogItem.Click"/>
+ method to check a particular radio button.
+ </remarks>
+ </member>
+ <member name="P:Ookii.Dialogs.TaskDialogRadioButton.ItemCollection">
+ <summary>
+ Gets the collection that items of this type are part of.
+ </summary>
+ <value>
+ If the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> is currently associated with a <see cref="T:Ookii.Dialogs.TaskDialog"/>, the
+ <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/> collection of that <see cref="T:Ookii.Dialogs.TaskDialog"/>; otherwise, <see langword="null"/>.
+ </value>
+ </member>
+ <member name="T:Ookii.Dialogs.HyperlinkClickedEventArgs">
+ <summary>
+ Class that provides data for the <see cref="E:Ookii.Dialogs.TaskDialog.HyperlinkClicked"/> event.
+ </summary>
+ <threadsafety instance="false" static="true"/>
+ </member>
+ <member name="M:Ookii.Dialogs.HyperlinkClickedEventArgs.#ctor(System.String)">
+ <summary>
+ Creates a new instance of the <see cref="T:Ookii.Dialogs.HyperlinkClickedEventArgs"/> class with the specified URL.
+ </summary>
+ <param name="href">The URL of the hyperlink.</param>
+ </member>
+ <member name="P:Ookii.Dialogs.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.ExpandButtonClickedEventArgs">
+ <summary>
+ Provides data for the <see cref="E:Ookii.Dialogs.TaskDialog.ExpandButtonClicked"/> event.
+ </summary>
+ <threadsafety instance="false" static="true"/>
+ </member>
+ <member name="M:Ookii.Dialogs.ExpandButtonClickedEventArgs.#ctor(System.Boolean)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.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.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>
+ </members>
+</doc>
diff --git a/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll b/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll Binary files differnew file mode 100644 index 000000000..5c6bcfa1d --- /dev/null +++ b/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll diff --git a/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll.config b/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll.config new file mode 100644 index 000000000..73859b00e --- /dev/null +++ b/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll.config @@ -0,0 +1,3 @@ +<?xml version="1.0"?>
+<configuration>
+ <startup/></configuration>
diff --git a/win/CS/libraries/OokiiDialogs/license.txt b/win/CS/libraries/OokiiDialogs/license.txt new file mode 100644 index 000000000..e46230167 --- /dev/null +++ b/win/CS/libraries/OokiiDialogs/license.txt @@ -0,0 +1,29 @@ +License agreement for Ookii.Dialogs.
+
+Copyright � Sven Groot (Ookii.org) 2009
+All rights reserved.
+
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1) Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+2) Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+3) Neither the name of the ORGANIZATION nor the names of its contributors
+ may be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file diff --git a/win/CS/libraries/ProgressBar/License.txt b/win/CS/libraries/ProgressBar/License.txt new file mode 100644 index 000000000..143b59ced --- /dev/null +++ b/win/CS/libraries/ProgressBar/License.txt @@ -0,0 +1,22 @@ +Copyright (c) 2009, wyDay
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file diff --git a/win/CS/libraries/ProgressBar/Windows7ProgressBar.XML b/win/CS/libraries/ProgressBar/Windows7ProgressBar.XML new file mode 100644 index 000000000..19f77deb2 --- /dev/null +++ b/win/CS/libraries/ProgressBar/Windows7ProgressBar.XML @@ -0,0 +1,106 @@ +<?xml version="1.0"?>
+<doc>
+ <assembly>
+ <name>Windows7ProgressBar</name>
+ </assembly>
+ <members>
+ <member name="T:wyDay.Controls.Windows7Taskbar">
+ <summary>
+ The primary coordinator of the Windows 7 taskbar-related activities.
+ </summary>
+ </member>
+ <member name="M:wyDay.Controls.Windows7Taskbar.SetProgressState(System.IntPtr,wyDay.Controls.ThumbnailProgressState)">
+ <summary>
+ Sets the progress state of the specified window's
+ taskbar button.
+ </summary>
+ <param name="hwnd">The window handle.</param>
+ <param name="state">The progress state.</param>
+ </member>
+ <member name="M:wyDay.Controls.Windows7Taskbar.SetProgressValue(System.IntPtr,System.UInt64,System.UInt64)">
+ <summary>
+ Sets the progress value of the specified window's
+ taskbar button.
+ </summary>
+ <param name="hwnd">The window handle.</param>
+ <param name="current">The current value.</param>
+ <param name="maximum">The maximum value.</param>
+ </member>
+ <!-- Badly formed XML comment ignored for member "T:wyDay.Controls.Windows7ProgressBar" -->
+ <member name="M:wyDay.Controls.Windows7ProgressBar.Increment(System.Int32)">
+ <summary>
+ Advances the current position of the progress bar by the specified amount.
+ </summary>
+ <param name="value">The amount by which to increment the progress bar's current position.</param>
+ </member>
+ <member name="M:wyDay.Controls.Windows7ProgressBar.PerformStep">
+ <summary>
+ Advances the current position of the progress bar by the amount of the System.Windows.Forms.ProgressBar.Step property.
+ </summary>
+ </member>
+ <member name="P:wyDay.Controls.Windows7ProgressBar.ShowInTaskbar">
+ <summary>
+ Show progress in taskbar
+ </summary>
+ </member>
+ <member name="P:wyDay.Controls.Windows7ProgressBar.Value">
+ <summary>
+ Gets or sets the current position of the progress bar.
+ </summary>
+ <returns>The position within the range of the progress bar. The default is 0.</returns>
+ </member>
+ <member name="P:wyDay.Controls.Windows7ProgressBar.Style">
+ <summary>
+ Gets or sets the manner in which progress should be indicated on the progress bar.
+ </summary>
+ <returns>One of the ProgressBarStyle values. The default is ProgressBarStyle.Blocks</returns>
+ </member>
+ <!-- Badly formed XML comment ignored for member "P:wyDay.Controls.Windows7ProgressBar.State" -->
+ <!-- Badly formed XML comment ignored for member "T:wyDay.Controls.ProgressBarState" -->
+ <member name="F:wyDay.Controls.ProgressBarState.Normal">
+ <summary>
+ Indicates normal progress
+ </summary>
+ </member>
+ <member name="F:wyDay.Controls.ProgressBarState.Error">
+ <summary>
+ Indicates an error in the progress
+ </summary>
+ </member>
+ <member name="F:wyDay.Controls.ProgressBarState.Pause">
+ <summary>
+ Indicates paused progress
+ </summary>
+ </member>
+ <member name="T:wyDay.Controls.ThumbnailProgressState">
+ <summary>
+ Represents the thumbnail progress bar state.
+ </summary>
+ </member>
+ <member name="F:wyDay.Controls.ThumbnailProgressState.NoProgress">
+ <summary>
+ No progress is displayed.
+ </summary>
+ </member>
+ <member name="F:wyDay.Controls.ThumbnailProgressState.Indeterminate">
+ <summary>
+ The progress is indeterminate (marquee).
+ </summary>
+ </member>
+ <member name="F:wyDay.Controls.ThumbnailProgressState.Normal">
+ <summary>
+ Normal progress is displayed.
+ </summary>
+ </member>
+ <member name="F:wyDay.Controls.ThumbnailProgressState.Error">
+ <summary>
+ An error occurred (red).
+ </summary>
+ </member>
+ <member name="F:wyDay.Controls.ThumbnailProgressState.Paused">
+ <summary>
+ The operation is paused (yellow).
+ </summary>
+ </member>
+ </members>
+</doc>
diff --git a/win/CS/libraries/ProgressBar/Windows7ProgressBar.dll b/win/CS/libraries/ProgressBar/Windows7ProgressBar.dll Binary files differnew file mode 100644 index 000000000..c8620e41a --- /dev/null +++ b/win/CS/libraries/ProgressBar/Windows7ProgressBar.dll diff --git a/win/CS/libraries/Source/HandBrakeInteropSource.zip b/win/CS/libraries/Source/HandBrakeInteropSource.zip Binary files differdeleted file mode 100644 index 8f4992168..000000000 --- a/win/CS/libraries/Source/HandBrakeInteropSource.zip +++ /dev/null |