--- /dev/null
+<?xml version="1.0"?>\r
+<doc>\r
+ <assembly>\r
+ <name>Ookii.Dialogs</name>\r
+ </assembly>\r
+ <members>\r
+ <member name="T:Ookii.Dialogs.ShellAnimation">\r
+ <summary>\r
+ Resource identifiers for default animations from shell32.dll.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ShellAnimation.FileMove">\r
+ <summary>\r
+ An animation representing a file move.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ShellAnimation.FileCopy">\r
+ <summary>\r
+ An animation representing a file copy.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ShellAnimation.FlyingPapers">\r
+ <summary>\r
+ An animation showing flying papers.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ShellAnimation.SearchGlobe">\r
+ <summary>\r
+ An animation showing a magnifying glass over a globe.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ShellAnimation.PermanentDelete">\r
+ <summary>\r
+ An animation representing a permament delete.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ShellAnimation.FromRecycleBinDelete">\r
+ <summary>\r
+ An animation representing deleting an item from the recycle bin.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ShellAnimation.ToRecycleBinDelete">\r
+ <summary>\r
+ An animation representing a file move to the recycle bin.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ShellAnimation.SearchComputer">\r
+ <summary>\r
+ An animation representing a search spanning the local computer.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ShellAnimation.SearchDocument">\r
+ <summary>\r
+ An animation representing a search in a document..\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ShellAnimation.SearchFlashlight">\r
+ <summary>\r
+ An animation representing a search using a flashlight animation.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.DownlevelTextMode">\r
+ <summary>\r
+ An enumeration that displays how the text in the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/>\r
+ properties is displayed on a credential dialog in Windows XP.\r
+ </summary>\r
+ <remarks>\r
+ <para>\r
+ Windows XP does not support the distinct visual style of the main instruction, so there is no visual difference between the\r
+ text of the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/> properties. Depending\r
+ on the scenario, you may wish to hide either the main instruction or the content text.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.DownlevelTextMode.MainInstructionAndContent">\r
+ <summary>\r
+ The text of the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/> properties is\r
+ concatenated together, separated by an empty line.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.DownlevelTextMode.MainInstructionOnly">\r
+ <summary>\r
+ Only the text of the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> property is shown.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.DownlevelTextMode.ContentOnly">\r
+ <summary>\r
+ Only the text of the <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/> property is shown.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.AnimationResource">\r
+ <summary>\r
+ Represents an animation for the <see cref="T:Ookii.Dialogs.ProgressDialog"/> loaded from a Win32 resource.\r
+ </summary>\r
+ <threadsafety instance="false" static="true"/>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.AnimationResource.#ctor(System.String,System.Int32)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.AnimationResource"/> class.\r
+ </summary>\r
+ <param name="resourceFile">The file containing the animation resource.</param>\r
+ <param name="resourceId">The resource ID of the animation resource.</param>\r
+ <exception cref="T:System.ArgumentNullException"><paramref name="resourceFile"/> is <see langword="null"/>.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.AnimationResource.GetShellAnimation(Ookii.Dialogs.ShellAnimation)">\r
+ <summary>\r
+ Gets a default animation from shell32.dll.\r
+ </summary>\r
+ <param name="animation">The animation to get.</param>\r
+ <returns>An instance of the <see cref="T:Ookii.Dialogs.AnimationResource"/> class representing the specified animation.</returns>\r
+ <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="animation"/> parameter was not a value defined in the\r
+ <see cref="T:Ookii.Dialogs.ShellAnimation"/> enumeration.</exception>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.AnimationResource.ResourceFile">\r
+ <summary>\r
+ Gets the name of the file containing the animation resource.\r
+ </summary>\r
+ <value>\r
+ The name of the file containing the animation resource. This is typically a DLL or EXE file.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.AnimationResource.ResourceId">\r
+ <summary>\r
+ Gets the ID of the animation resource.\r
+ </summary>\r
+ <value>\r
+ The ID of the animation resource.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.TaskDialog">\r
+ <summary>\r
+ Displays a Task Dialog.\r
+ </summary>\r
+ <remarks>\r
+ The task dialog contains an application-defined message text and title, icons, and any combination of predefined push buttons.\r
+ Task Dialogs are supported only on Windows Vista and above. No fallback is provided; if you wish to use task dialogs\r
+ and support operating systems older than Windows Vista, you must provide a fallback yourself. Check the <see cref="P:Ookii.Dialogs.TaskDialog.OSSupportsTaskDialogs"/>\r
+ property to see if task dialogs are supported. It is safe to instantiate the <see cref="T:Ookii.Dialogs.TaskDialog"/> class on an older\r
+ OS, but calling <see cref="M:Ookii.Dialogs.TaskDialog.Show"/> or <see cref="M:Ookii.Dialogs.TaskDialog.ShowDialog"/> will throw an exception.\r
+ </remarks>\r
+ <threadsafety static="true" instance="false"/>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.TaskDialog.components">\r
+ <summary>\r
+ Required designer variable.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.Dispose(System.Boolean)">\r
+ <summary> \r
+ Clean up any resources being used.\r
+ </summary>\r
+ <param name="disposing"><see langword="true" /> if managed resources should be disposed; otherwise, <see langword="false" />.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.InitializeComponent">\r
+ <summary>\r
+ Required method for Designer support - do not modify\r
+ the contents of this method with the code editor.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.#ctor">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialog"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.#ctor(System.ComponentModel.IContainer)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialog"/> class with the specified container.\r
+ </summary>\r
+ <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.TaskDialog"/> to.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.Show">\r
+ <summary>\r
+ Shows the task dialog as a modeless dialog.\r
+ </summary>\r
+ <returns>The button that the user clicked. Can be <see langword="null"/> if the user cancelled the dialog using the\r
+ title bar close button.</returns>\r
+ <remarks>\r
+ <note>\r
+ Although the dialog is modeless, this method does not return until the task dialog is closed.\r
+ </note>\r
+ </remarks>\r
+ <exception cref="T:System.InvalidOperationException">\r
+ <para>\r
+ One of the properties or a combination of properties is not valid.\r
+ </para>\r
+ <para>\r
+ -or-\r
+ </para>\r
+ <para>\r
+ The dialog is already running.\r
+ </para>\r
+ </exception>\r
+ <exception cref="T:System.NotSupportedException">Task dialogs are not supported on the current operating system.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.ShowDialog">\r
+ <summary>\r
+ Shows the task dialog as a modal dialog.\r
+ </summary>\r
+ <returns>The button that the user clicked. Can be <see langword="null"/> if the user cancelled the dialog using the\r
+ title bar close button.</returns>\r
+ <remarks>\r
+ The dialog will use the active window as its owner. If the current process has no active window,\r
+ the dialog will be displayed as a modeless dialog (identical to calling <see cref="M:Ookii.Dialogs.TaskDialog.Show"/>).\r
+ </remarks>\r
+ <exception cref="T:System.InvalidOperationException">\r
+ <para>\r
+ One of the properties or a combination of properties is not valid.\r
+ </para>\r
+ <para>\r
+ -or-\r
+ </para>\r
+ <para>\r
+ The dialog is already running.\r
+ </para>\r
+ </exception>\r
+ <exception cref="T:System.NotSupportedException">Task dialogs are not supported on the current operating system.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.ShowDialog(System.Windows.Forms.IWin32Window)">\r
+ <summary>\r
+ This method is for internal Ookii.Dialogs use and should not be called from your code.\r
+ </summary>\r
+ <param name="owner"></param>\r
+ <returns></returns>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.ClickVerification(System.Boolean,System.Boolean)">\r
+ <summary>\r
+ Simulates a click on the verification checkbox of the <see cref="T:Ookii.Dialogs.TaskDialog"/>, if it exists.\r
+ </summary>\r
+ <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>\r
+ <param name="setFocus"><see langword="true"/> to set the keyboard focus to the checkbox; otherwise <see langword="false"/>.</param>\r
+ <exception cref="T:System.InvalidOperationException">The task dialog is not being displayed.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.OnHyperlinkClicked(Ookii.Dialogs.HyperlinkClickedEventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.HyperlinkClicked"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:Ookii.Dialogs.HyperlinkClickedEventArgs"/> containing the data for the event.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.OnButtonClicked(Ookii.Dialogs.TaskDialogItemClickedEventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.ButtonClicked"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:Ookii.Dialogs.TaskDialogItemClickedEventArgs"/> containing the data for the event.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.OnRadioButtonClicked(Ookii.Dialogs.TaskDialogItemClickedEventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.RadioButtonClicked"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:Ookii.Dialogs.TaskDialogItemClickedEventArgs"/> containing the data for the event.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.OnVerificationClicked(System.EventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.VerificationClicked"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.OnCreated(System.EventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.Created"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.OnTimer(Ookii.Dialogs.TimerEventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:Ookii.Dialogs.TimerEventArgs"/> containing the data for the event.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.OnDestroyed(System.EventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.Destroyed"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.OnExpandButtonClicked(Ookii.Dialogs.ExpandButtonClickedEventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.ExpandButtonClicked"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:Ookii.Dialogs.ExpandButtonClickedEventArgs"/> containing the data for the event.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialog.OnHelpRequested(System.EventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.TaskDialog.HelpRequested"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.TaskDialog.Created">\r
+ <summary>\r
+ Event raised when the task dialog has been created.\r
+ </summary>\r
+ <remarks>\r
+ This event is raised once after calling <see cref="M:Ookii.Dialogs.TaskDialog.ShowDialog(System.Windows.Forms.IWin32Window)"/>, after the dialog\r
+ is created and before it is displayed.\r
+ </remarks>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.TaskDialog.Destroyed">\r
+ <summary>\r
+ Event raised when the task dialog has been destroyed.\r
+ </summary>\r
+ <remarks>\r
+ The task dialog window no longer exists when this event is raised.\r
+ </remarks>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.TaskDialog.ButtonClicked">\r
+ <summary>\r
+ Event raised when the user clicks a button on the task dialog.\r
+ </summary>\r
+ <remarks>\r
+ Set the <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> property to <see langword="true"/> to prevent the dialog from being closed.\r
+ </remarks>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.TaskDialog.RadioButtonClicked">\r
+ <summary>\r
+ Event raised when the user clicks a radio button on the task dialog.\r
+ </summary>\r
+ <remarks>\r
+ The <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> property is ignored for this event.\r
+ </remarks>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.TaskDialog.HyperlinkClicked">\r
+ <summary>\r
+ Event raised when the user clicks a hyperlink.\r
+ </summary>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.TaskDialog.VerificationClicked">\r
+ <summary>\r
+ Event raised when the user clicks the verification check box.\r
+ </summary>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.TaskDialog.Timer">\r
+ <summary>\r
+ Event raised periodically while the dialog is displayed.\r
+ </summary>\r
+ <remarks>\r
+ <para>\r
+ This event is raised only when the <see cref="P:Ookii.Dialogs.TaskDialog.RaiseTimerEvent"/> property is set to <see langword="true"/>. The event is\r
+ raised approximately every 200 milliseconds.\r
+ </para>\r
+ <para>\r
+ To reset the tick count, set the <see cref="P:Ookii.Dialogs.TimerEventArgs.ResetTickCount"/>\r
+ property to <see langword="true"/>.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.TaskDialog.ExpandButtonClicked">\r
+ <summary>\r
+ Event raised when the user clicks the expand button on the task dialog.\r
+ </summary>\r
+ <remarks>\r
+ The <see cref="P:Ookii.Dialogs.ExpandButtonClickedEventArgs.Expanded"/> property indicates if the expanded information is visible\r
+ or not after the click.\r
+ </remarks>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.TaskDialog.HelpRequested">\r
+ <summary>\r
+ Event raised when the user presses F1 while the dialog has focus.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.OSSupportsTaskDialogs">\r
+ <summary>\r
+ Gets a value that indicates whether the current operating system supports task dialogs.\r
+ </summary>\r
+ <value>\r
+ Returns <see langword="true" /> for Windows Vista or later; otherwise <see langword="false" />.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.Buttons">\r
+ <summary>\r
+ Gets a list of the buttons on the Task Dialog.\r
+ </summary>\r
+ <value>\r
+ A list of the buttons on the Task Dialog.\r
+ </value>\r
+ <remarks>\r
+ Custom buttons are displayed in the order they have in the collection. Standard buttons will always be displayed\r
+ in the Windows-defined order, regardless of the order of the buttons in the collection.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.RadioButtons">\r
+ <summary>\r
+ Gets a list of the radio buttons on the Task Dialog.\r
+ </summary>\r
+ <value>\r
+ A list of the radio buttons on the Task Dialog.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.WindowTitle">\r
+ <summary>\r
+ Gets or sets the window title of the task dialog.\r
+ </summary>\r
+ <value>\r
+ The window title of the task dialog. The default is an empty string ("").\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.MainInstruction">\r
+ <summary>\r
+ Gets or sets the dialog's main instruction.\r
+ </summary>\r
+ <value>\r
+ The dialog's main instruction. The default is an empty string ("").\r
+ </value>\r
+ <remarks>\r
+ The main instruction of a task dialog will be displayed in a larger font and a different color than\r
+ the other text of the task dialog.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.Content">\r
+ <summary>\r
+ Gets or sets the dialog's primary content.\r
+ </summary>\r
+ <value>\r
+ The dialog's primary content. The default is an empty string ("").\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.WindowIcon">\r
+ <summary>\r
+ Gets or sets the icon to be used in the title bar of the dialog.\r
+ </summary>\r
+ <value>\r
+ An <see cref="T:System.Drawing.Icon"/> that represents the icon of the task dialog's window.\r
+ </value>\r
+ <remarks>\r
+ This property is used only when the dialog is shown as a modeless dialog; if the dialog\r
+ is modal, it will have no icon.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.MainIcon">\r
+ <summary>\r
+ Gets or sets the icon to display in the task dialog.\r
+ </summary>\r
+ <value>\r
+ A <see cref="T:Ookii.Dialogs.TaskDialogIcon"/> that indicates the icon to display in the main content area of the task dialog.\r
+ The default is <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>.\r
+ </value>\r
+ <remarks>\r
+ When this property is set to <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>, use the <see cref="P:Ookii.Dialogs.TaskDialog.CustomMainIcon"/> property to\r
+ specify the icon to use.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.CustomMainIcon">\r
+ <summary>\r
+ Gets or sets a custom icon to display in the dialog.\r
+ </summary>\r
+ <value>\r
+ An <see cref="T:System.Drawing.Icon"/> that represents the icon to display in the main content area of the task dialog,\r
+ or <see langword="null"/> if no custom icon is used. The default value is <see langword="null"/>.\r
+ </value>\r
+ <remarks>\r
+ 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"/>.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.FooterIcon">\r
+ <summary>\r
+ Gets or sets the icon to display in the footer area of the task dialog.\r
+ </summary>\r
+ <value>\r
+ A <see cref="T:Ookii.Dialogs.TaskDialogIcon"/> that indicates the icon to display in the footer area of the task dialog.\r
+ The default is <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>.\r
+ </value> \r
+ <remarks>\r
+ <para>\r
+ When this property is set to <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>, use the <see cref="P:Ookii.Dialogs.TaskDialog.CustomFooterIcon"/> property to\r
+ specify the icon to use.\r
+ </para>\r
+ <para>\r
+ The footer icon is displayed only if the <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> property is not an empty string ("").\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.CustomFooterIcon">\r
+ <summary>\r
+ Gets or sets a custom icon to display in the footer area of the task dialog.\r
+ </summary>\r
+ <value>\r
+ An <see cref="T:System.Drawing.Icon"/> that represents the icon to display in the footer area of the task dialog,\r
+ or <see langword="null"/> if no custom icon is used. The default value is <see langword="null"/>.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ 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"/>.\r
+ </para>\r
+ <para>\r
+ The footer icon is displayed only if the <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> property is not an empty string ("").\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.ButtonStyle">\r
+ <summary>\r
+ Gets or sets a value that indicates whether custom buttons should be displayed as normal buttons or command links.\r
+ </summary>\r
+ <value>\r
+ A <see cref="T:Ookii.Dialogs.TaskDialogButtonStyle"/> that indicates the display style of custom buttons on the dialog.\r
+ The default value is <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.Standard"/>.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ This property affects only custom buttons, not standard ones.\r
+ </para>\r
+ <para>\r
+ If a custom button is being displayed on a task dialog\r
+ with <see cref="P:Ookii.Dialogs.TaskDialog.ButtonStyle"/> set to <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinks"/>\r
+ or <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinksNoIcon"/>, you delineate the command from the \r
+ note by placing a line break in the string specified by <see cref="P:Ookii.Dialogs.TaskDialogItem.Text"/> property.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.VerificationText">\r
+ <summary>\r
+ Gets or sets the label for the verification checkbox.\r
+ </summary>\r
+ <value>\r
+ The label for the verification checkbox, or an empty string ("") if no verification checkbox\r
+ is shown. The default value is an empty string ("").\r
+ </value>\r
+ <remarks>\r
+ If no text is set, the verification checkbox will not be shown.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.IsVerificationChecked">\r
+ <summary>\r
+ Gets or sets a value that indicates whether the verification checkbox is checked ot not.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the verficiation checkbox is checked; otherwise, <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ Set this property before displaying the dialog to determine the initial state of the check box.\r
+ Use this property after displaying the dialog to determine whether the check box was checked when\r
+ the user closed the dialog.\r
+ </para>\r
+ <note>\r
+ This property is only used if <see cref="P:Ookii.Dialogs.TaskDialog.VerificationText"/> is not an empty string ("").\r
+ </note>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.ExpandedInformation">\r
+ <summary>\r
+ Gets or sets additional information to be displayed on the dialog.\r
+ </summary>\r
+ <value>\r
+ Additional information to be displayed on the dialog. The default value is an empty string ("").\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ When this property is not an empty string (""), a control is shown on the task dialog that\r
+ allows the user to expand and collapse the text specified in this property.\r
+ </para>\r
+ <para>\r
+ The text is collapsed by default unless <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedByDefault"/> is set to <see langword="true"/>.\r
+ </para>\r
+ <para>\r
+ The expanded text is shown in the main content area of the dialog, unless <see cref="P:Ookii.Dialogs.TaskDialog.ExpandFooterArea"/>\r
+ is set to <see langword="true"/>, in which case it is shown in the footer area.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.ExpandedControlText">\r
+ <summary>\r
+ Gets or sets the text to use for the control for collapsing the expandable information specified in <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>.\r
+ </summary>\r
+ <value>\r
+ The text to use for the control for collapsing the expandable information, or an empty string ("") if the\r
+ operating system's default text is to be used. The default is an empty string ("")\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ 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"/>\r
+ will be used for this property as well. If neither is specified, the operating system's default text is used.\r
+ </para>\r
+ <note>\r
+ The control for collapsing or expanding the expandable information is displayed only if <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> is not\r
+ an empty string ("")\r
+ </note>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.CollapsedControlText">\r
+ <summary>\r
+ Gets or sets the text to use for the control for expading the expandable information specified in <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>.\r
+ </summary>\r
+ <value>\r
+ The text to use for the control for expanding the expandable information, or an empty string ("") if the\r
+ operating system's default text is to be used. The default is an empty string ("")\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ 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"/>\r
+ will be used for this property as well. If neither is specified, the operating system's default text is used.\r
+ </para>\r
+ <note>\r
+ The control for collapsing or expanding the expandable information is displayed only if <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> is not\r
+ an empty string ("")\r
+ </note>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.Footer">\r
+ <summary>\r
+ Gets or sets the text to be used in the footer area of the task dialog.\r
+ </summary>\r
+ <value>\r
+ The text to be used in the footer area of the task dialog, or an empty string ("")\r
+ if the footer area is not displayed. The default value is an empty string ("").\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.Width">\r
+ <summary>\r
+ Specifies the width of the task dialog's client area in DLU's.\r
+ </summary>\r
+ <value>\r
+ The width of the task dialog's client area in DLU's, or 0 to have the task dialog calculate the ideal width.\r
+ The default value is 0.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.EnableHyperlinks">\r
+ <summary>\r
+ 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"/>\r
+ and <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> properties.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> when hyperlinks are allowed for the <see cref="P:Ookii.Dialogs.TaskDialog.Content"/>, <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>\r
+ and <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> properties; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ When this property is <see langword="true"/>, the <see cref="P:Ookii.Dialogs.TaskDialog.Content"/>, <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>\r
+ and <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> properties can use hyperlinks in the following form: <c><A HREF="executablestring">Hyperlink Text</A></c>\r
+ </para>\r
+ <note>\r
+ Enabling hyperlinks when using content from an unsafe source may cause security vulnerabilities.\r
+ </note>\r
+ <para>\r
+ Task dialogs will not actually execute hyperlinks. To take action when the user presses a hyperlink, handle the\r
+ <see cref="E:Ookii.Dialogs.TaskDialog.HyperlinkClicked"/> event.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.AllowDialogCancellation">\r
+ <summary>\r
+ Gets or sets a value that indicates that the dialog should be able to be closed using Alt-F4, Escape and the title\r
+ bar's close button even if no cancel button is specified.\r
+ </summary>\r
+ <value>\r
+ <see langword="true" /> if the dialog can be closed using Alt-F4, Escape and the title\r
+ bar's close button even if no cancel button is specified; otherwise, <see langword="false" />.\r
+ The default value is <see langword="false" />.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.ExpandFooterArea">\r
+ <summary>\r
+ Gets or sets a value that indicates that the string specified by the <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> property\r
+ should be displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the string specified by the <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> property\r
+ should be displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content;\r
+ otherwise, <see langword="false"/>. The default value is <see langword="false"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.ExpandedByDefault">\r
+ <summary>\r
+ Gets or sets a value that indicates that the string specified by the <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> property\r
+ should be displayed by default.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the string specified by the <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> property\r
+ should be displayed by default; <see langword="false"/> if it is hidden by default. The default value is\r
+ <see langword="false"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.RaiseTimerEvent">\r
+ <summary>\r
+ Gets or sets a value that indicates whether the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event is raised periodically while the dialog\r
+ is visible.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> when the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event is raised periodically while the dialog is visible; otherwise,\r
+ <see langword="false"/>. The default value is <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ The <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event will be raised approximately every 200 milliseconds if this property is <see langword="true"/>.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.CenterParent">\r
+ <summary>\r
+ Gets or sets a value that indicates whether the dialog is centered in the parent window instead of the screen.\r
+ </summary>\r
+ <value>\r
+ <see langword="true" /> when the dialog is centered relative to the parent window; <see langword="false" /> when it is centered on the screen.\r
+ The default value is <see langword="false" />.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.RightToLeft">\r
+ <summary>\r
+ Gets or sets a value that indicates whether text is displayed right to left.\r
+ </summary>\r
+ <value>\r
+ <see langword="true" /> when the content of the dialog is displayed right to left; otherwise, <see langword="false" />.\r
+ The default value is <see langword="false" />.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.MinimizeBox">\r
+ <summary>\r
+ Gets or sets a value that indicates whether the dialog has a minimize box on its caption bar.\r
+ </summary>\r
+ <value>\r
+ <see langword="true" /> if the dialog has a minimize box on its caption bar when modeless; otherwise,\r
+ <see langword="false" />. The default is <see langword="false" />.\r
+ </value>\r
+ <remarks>\r
+ A task dialog can only have a minimize box if it is displayed as a modeless dialog. The minimize box\r
+ will never appear when using the designer "Preview" option, since that displays the dialog modally.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle">\r
+ <summary>\r
+ Gets or sets the type of progress bar displayed on the dialog.\r
+ </summary>\r
+ <value>\r
+ A <see cref="T:Ookii.Dialogs.ProgressBarStyle"/> that indicates the type of progress bar shown on the task dialog.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ If this property is set to <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>, the marquee will\r
+ scroll as long as the dialog is visible.\r
+ </para>\r
+ <para>\r
+ If this property is set to <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>, the value of the\r
+ <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarValue"/> property must be updated to advance the progress bar. This can be done e.g. by\r
+ an asynchronous operation or from the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event.\r
+ </para>\r
+ <note>\r
+ 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\r
+ the thread on which the task dialog was created.\r
+ </note>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarMarqueeAnimationSpeed">\r
+ <summary>\r
+ Gets or sets the marquee animation speed of the progress bar in milliseconds.\r
+ </summary>\r
+ <value>\r
+ The marquee animation speed of the progress bar in milliseconds. The default value is 100.\r
+ </value>\r
+ <remarks>\r
+ This property is only used if the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle"/> property is \r
+ <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarMinimum">\r
+ <summary>\r
+ Gets or sets the lower bound of the range of the task dialog's progress bar.\r
+ </summary>\r
+ <value>\r
+ The lower bound of the range of the task dialog's progress bar. The default value is 0.\r
+ </value>\r
+ <remarks>\r
+ This property is only used if the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle"/> property is \r
+ <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentOutOfRangeException">The new property value is not smaller than <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarMaximum"/>.</exception>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarMaximum">\r
+ <summary>\r
+ Gets or sets the upper bound of the range of the task dialog's progress bar.\r
+ </summary>\r
+ <value>\r
+ The upper bound of the range of the task dialog's progress bar. The default value is 100.\r
+ </value>\r
+ <remarks>\r
+ This property is only used if the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle"/> property is \r
+ <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentOutOfRangeException">The new property value is not larger than <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarMinimum"/>.</exception>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarValue">\r
+ <summary>\r
+ Gets or sets the current value of the task dialog's progress bar.\r
+ </summary>\r
+ <value>\r
+ The current value of the task dialog's progress bar. The default value is 0.\r
+ </value>\r
+ <remarks>\r
+ This property is only used if the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle"/> property is \r
+ <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.\r
+ <note>\r
+ Updating the value of the progress bar while the dialog is visible may only be done from\r
+ the thread on which the task dialog was created.\r
+ </note>\r
+ </remarks>\r
+ <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>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarState">\r
+ <summary>\r
+ Gets or sets the state of the task dialog's progress bar.\r
+ </summary>\r
+ <value>\r
+ A <see cref="T:Ookii.Dialogs.ProgressBarState"/> indicating the state of the task dialog's progress bar.\r
+ The default value is <see cref="F:Ookii.Dialogs.ProgressBarState.Normal"/>.\r
+ </value>\r
+ <remarks>\r
+ This property is only used if the <see cref="T:Ookii.Dialogs.ProgressBarStyle"/> property is \r
+ <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.Tag">\r
+ <summary>\r
+ Gets or sets an object that contains data about the dialog.\r
+ </summary>\r
+ <value>\r
+ An object that contains data about the dialog. The default value is <see langword="null" />.\r
+ </value>\r
+ <remarks>\r
+ Use this property to store arbitrary information about the dialog.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialog.Handle">\r
+ <summary>\r
+ Gets the window handle of the task dialog.\r
+ </summary>\r
+ <value>\r
+ The window handle of the task dialog when it is being displayed, or <see cref="F:System.IntPtr.Zero"/> when the dialog\r
+ is not being displayed.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.TaskDialogItemCollection`1">\r
+ <summary>\r
+ Represents a list of <see cref="T:Ookii.Dialogs.TaskDialogItem"/> objects.\r
+ </summary>\r
+ <typeparam name="T">The type of the task dialog item.</typeparam>\r
+ <threadsafety instance="false" static="true"/>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogItemCollection`1.ClearItems">\r
+ <summary>\r
+ Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.ClearItems"/> method.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogItemCollection`1.InsertItem(System.Int32,`0)">\r
+ <summary>\r
+ Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.InsertItem(System.Int32,`0)"/> method.\r
+ </summary>\r
+ <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>\r
+ <param name="item">The object to insert. May not be <see langword="null"/>.</param>\r
+ <exception cref="T:System.ArgumentNullException"><paramref name="item"/> is <see langword="null"/>.</exception>\r
+ <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>\r
+ <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>\r
+ <exception cref="T:System.ArgumentOutOfRangeException">\r
+ <para>\r
+ <paramref name="index"/> is less than zero.\r
+ </para>\r
+ <para>\r
+ -or-\r
+ </para>\r
+ <para>\r
+ <paramref name="index"/> is equal to or greater than <see cref="P:System.Collections.ObjectModel.Collection`1.Count"/>.\r
+ </para>\r
+ </exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogItemCollection`1.RemoveItem(System.Int32)">\r
+ <summary>\r
+ Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.RemoveItem(System.Int32)"/> method.\r
+ </summary>\r
+ <param name="index">The zero-based index of the element to remove.</param>\r
+ <exception cref="T:System.ArgumentOutOfRangeException">\r
+ <para>\r
+ <paramref name="index"/> is less than zero.\r
+ </para>\r
+ <para>\r
+ -or-\r
+ </para>\r
+ <para>\r
+ <paramref name="index"/> is equal to or greater than <see cref="P:System.Collections.ObjectModel.Collection`1.Count"/>.\r
+ </para>\r
+ </exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogItemCollection`1.SetItem(System.Int32,`0)">\r
+ <summary>\r
+ Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.SetItem(System.Int32,`0)"/> method.\r
+ </summary>\r
+ <param name="index">The zero-based index of the element to replace.</param>\r
+ <param name="item">The new value for the element at the specified index. May not be <see langword="null"/>.</param>\r
+ <exception cref="T:System.ArgumentNullException"><paramref name="item"/> is <see langword="null"/>.</exception>\r
+ <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>\r
+ <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>\r
+ <exception cref="T:System.ArgumentOutOfRangeException">\r
+ <para>\r
+ <paramref name="index"/> is less than zero.\r
+ </para>\r
+ <para>\r
+ -or-\r
+ </para>\r
+ <para>\r
+ <paramref name="index"/> is equal to or greater than <see cref="P:System.Collections.ObjectModel.Collection`1.Count"/>.\r
+ </para>\r
+ </exception>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.ProgressBarState">\r
+ <summary>\r
+ Represents the state of the progress bar on the task dialog.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ProgressBarState.Normal">\r
+ <summary>\r
+ Normal state.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ProgressBarState.Error">\r
+ <summary>\r
+ Error state\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ProgressBarState.Paused">\r
+ <summary>\r
+ Paused state\r
+ </summary>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.ExtendedForm">\r
+ <summary>\r
+ Base class for windows forms with extended functionality.\r
+ </summary>\r
+ <remarks>\r
+ <para>\r
+ In order to use this class, create a new Form in Visual Studio, then modify the base\r
+ class in the .cs (or in Visual Basic, the .Designer.vb) file for the form to this class.\r
+ </para>\r
+ <para>\r
+ This class provides two main pieces of functionality: the ability to use the system font\r
+ and the ability to use client area glass in Windows Vista.\r
+ </para>\r
+ <para>\r
+ Windows Forms applications will normally always use MS Sans Serif 8pt, even when the\r
+ system font is something else. For example, on Windows XP (English), the system font\r
+ is Tahoma 8pt. On Windows XP Japanese, the system font is MS UI Gothic 8pt. On Windows\r
+ Vista it is Segoe UI 9pt. By setting the <see cref="P:Ookii.Dialogs.ExtendedForm.UseSystemFont"/> property to <see langword="true"/> for a form,\r
+ that form will automatically use the proper system font.\r
+ </para>\r
+ <para>\r
+ Because the font metrics of these different fonts can be vary greatly\r
+ (especially on Vista which uses a larger font), please make sure the \r
+ <see cref="P:System.Windows.Forms.ContainerControl.AutoScaleMode"/> property is set to\r
+ <see cref="F:System.Windows.Forms.AutoScaleMode.Font"/>, and make special provisions for resizing\r
+ graphics and other elements.\r
+ Please note that some system fonts (such as MS UI Gothic) can also be smaller than MS Sans Serif\r
+ which means the form will be scaled down, not up.\r
+ </para>\r
+ <note>\r
+ If you set <see cref="P:Ookii.Dialogs.ExtendedForm.UseSystemFont"/> to <see langword="true"/>, it is strongly recommended you\r
+ test your application with various different font and DPI settings.\r
+ </note>\r
+ <para>\r
+ To use glass with your form, use the <see cref="P:Ookii.Dialogs.ExtendedForm.GlassMargin"/> property. You can also\r
+ specify whether it's possible to drag the form by its glass areas using the <see cref="P:Ookii.Dialogs.ExtendedForm.AllowGlassDragging"/>\r
+ property. Glass requires Windows Vista with the Desktop Window Manager enabled. The glass related\r
+ properties have no effect on other operating systems.\r
+ </para>\r
+ <note>\r
+ Many Windows Forms controls will not display correctly when placed over a glass area. Use the \r
+ <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.\r
+ </note>\r
+ <para>\r
+ This class will automatically handle changes in the system font or DWM settings (including enabling/disabling\r
+ of the DWM) while the application is running.\r
+ </para>\r
+ </remarks>\r
+ <threadsafety instance="false" static="true"/>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ExtendedForm.#ctor">\r
+ <summary>\r
+ Creates a new instance of the <see cref="T:Ookii.Dialogs.ExtendedForm"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ExtendedForm.OnDwmCompositionChanged(System.EventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.ExtendedForm.DwmCompositionChanged"/> event.\r
+ </summary>\r
+ <param name="e">An <see cref="T:System.EventArgs"/> containing the event data.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ExtendedForm.OnLoad(System.EventArgs)">\r
+ <summary>\r
+ Overrides the <see cref="M:System.Windows.Forms.Form.OnLoad(System.EventArgs)"/> method.\r
+ </summary>\r
+ <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ExtendedForm.OnFormClosed(System.Windows.Forms.FormClosedEventArgs)">\r
+ <summary>\r
+ Overrides the <see cref="M:System.Windows.Forms.Form.OnFormClosed(System.Windows.Forms.FormClosedEventArgs)"/> method.\r
+ </summary>\r
+ <param name="e">A <see cref="T:System.Windows.Forms.FormClosedEventArgs"/> that contains the event data.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ExtendedForm.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">\r
+ <summary>\r
+ Paints the background of the control.\r
+ </summary>\r
+ <param name="pevent">A <see cref="T:System.Windows.Forms.PaintEventArgs"/> that contains the event data.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ExtendedForm.OnResize(System.EventArgs)">\r
+ <summary>\r
+ This member overrides <see cref="M:System.Windows.Forms.Form.OnResize(System.EventArgs)"/>.\r
+ </summary>\r
+ <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ExtendedForm.OnHandleCreated(System.EventArgs)">\r
+ <summary>\r
+ This member overrides <see cref="M:System.Windows.Forms.Form.OnHandleCreated(System.EventArgs)"/>.\r
+ </summary>\r
+ <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ExtendedForm.WndProc(System.Windows.Forms.Message@)">\r
+ <summary>\r
+ This member overrides <see cref="M:System.Windows.Forms.Form.WndProc(System.Windows.Forms.Message@)"/>.\r
+ </summary>\r
+ <param name="m">The Windows <see cref="T:System.Windows.Forms.Message"/> to process.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ExtendedForm.ScaleControl(System.Drawing.SizeF,System.Windows.Forms.BoundsSpecified)">\r
+ <summary>\r
+ Overrides <see cref="M:System.Windows.Forms.Form.ScaleControl(System.Drawing.SizeF,System.Windows.Forms.BoundsSpecified)"/>.\r
+ </summary>\r
+ <param name="factor">The height and width of the control's bounds.</param>\r
+ <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>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.ExtendedForm.DwmCompositionChanged">\r
+ <summary>\r
+ Raised when Desktop Window Manager (DWM) composition has been enabled or disabled.\r
+ </summary>\r
+ <remarks>\r
+ <note>\r
+ This event is only raised on Windows Vista or later.\r
+ </note>\r
+ <para>\r
+ Use the <see cref="P:Ookii.Dialogs.Glass.IsDwmCompositionEnabled"/> property to determine the\r
+ current composition state.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ExtendedForm.UseSystemFont">\r
+ <summary>\r
+ Gets or sets a value that indicates whether or not the form automatically uses the system default font.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> when the form's font is automatically adjusted to the system font; \r
+ otherwise, <see langword="false"/>. The default value is <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ This property has no effect at design time; the font settings will only be applied at\r
+ run time.\r
+ </para>\r
+ <para>\r
+ When this property is set to <see langword="true"/>, the form will use the configured \r
+ system font and font size automatically, e.g. it will use Segoe UI on Windows Vista and \r
+ Tahoma on Windows XP. Please make sure the <see cref="P:System.Windows.Forms.ContainerControl.AutoScaleMode"/> \r
+ property is set to <see cref="F:System.Windows.Forms.AutoScaleMode.Font"/> \r
+ to account for the different metrics of the various fonts, and make special provisions \r
+ to scale graphics and other element. Note that the system font can also be smaller than\r
+ the font you used at design time, causing the form to be scaled down. For example the font\r
+ MS Gothic UI, used on Japanese versions of Windows (pre-Vista), has smaller metrics than\r
+ MS Sans Serif.\r
+ </para>\r
+ <note>\r
+ It is strongly recommended to test your application with different font and DPI settings if you set this property\r
+ to <see langword="true"/>.\r
+ </note>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ExtendedForm.GlassMargin">\r
+ <summary>\r
+ Gets or sets the glass margins of the form.\r
+ </summary>\r
+ <value>\r
+ A <see cref="T:System.Windows.Forms.Padding"/> that indicates the glass margins of the form. The default value is\r
+ <see cref="F:System.Windows.Forms.Padding.Empty"/>.\r
+ </value>\r
+ <remarks>\r
+ <note>\r
+ Client-area glass requires Windows Vista or later with the Desktop Window Manager enabled. If the Desktop\r
+ Window Manager is not enabled, or an older version of Windows is used, this property is ignored.\r
+ </note>\r
+ <para>\r
+ Client-area glass extends the glass frame used by the Windows Vista Aero user interface into the client\r
+ area of your window.\r
+ </para>\r
+ <para>\r
+ Use negative margins to create the "sheet of glass" effect where the client area is rendered \r
+ as a completely glass surface.\r
+ </para>\r
+ <para>\r
+ Text rendered with the <see cref="T:System.Windows.Forms.TextRenderer"/> will not display correctly on the glass area (this includes\r
+ 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)"/>.\r
+ </para>\r
+ <para>\r
+ If the form is scaled, which can happen for instance if <see cref="P:Ookii.Dialogs.ExtendedForm.UseSystemFont"/> is <see langword="true"/>,\r
+ the glass margin will also be scaled.\r
+ </para>\r
+ <para>\r
+ At design time, the glass area will be indicated by a pattern drawn onto the form. This pattern will not\r
+ be visible at runtime regardless of whether the glass is enabled or not.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ExtendedForm.AllowGlassDragging">\r
+ <summary>\r
+ Gets or sets a value that indicates whether the form can be dragged by the glass areas inside the client area.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> when the form can be dragged using the client area glass; otherwise, <see langword="false"/>.\r
+ The default value is <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ This property has no effect on operating systems older than Windows Vista, when the Desktop Window Manager is disabled\r
+ or when the <see cref="P:Ookii.Dialogs.ExtendedForm.GlassMargin"/> property is set to zero.\r
+ </remarks>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.InputDialogForm.components">\r
+ <summary>\r
+ Required designer variable.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.InputDialogForm.Dispose(System.Boolean)">\r
+ <summary>\r
+ Clean up any resources being used.\r
+ </summary>\r
+ <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.InputDialogForm.InitializeComponent">\r
+ <summary>\r
+ Required method for Designer support - do not modify\r
+ the contents of this method with the code editor.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.TaskDialogIcon">\r
+ <summary>\r
+ Indicates the icon to use for a task dialog.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.TaskDialogIcon.Custom">\r
+ <summary>\r
+ A custom icon or no icon if no custom icon is specified.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.TaskDialogIcon.Warning">\r
+ <summary>\r
+ System warning icon.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.TaskDialogIcon.Error">\r
+ <summary>\r
+ System Error icon.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.TaskDialogIcon.Information">\r
+ <summary>\r
+ System Information icon.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.TaskDialogIcon.Shield">\r
+ <summary>\r
+ Shield icon.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.ProgressDialog">\r
+ <summary>\r
+ Represents a dialog that can be used to report progress to the user.\r
+ </summary>\r
+ <remarks>\r
+ <para>\r
+ This class provides a wrapper for the native Windows IProgressDialog API.\r
+ </para>\r
+ <para>\r
+ The <see cref="T:Ookii.Dialogs.ProgressDialog"/> class requires Windows 2000, Windows Me, or newer versions of Windows.\r
+ </para>\r
+ </remarks>\r
+ <threadsafety static="true" instance="false"/>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ProgressDialog.components">\r
+ <summary>\r
+ Required designer variable.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.Dispose(System.Boolean)">\r
+ <summary> \r
+ Clean up any resources being used.\r
+ </summary>\r
+ <param name="disposing"><see langword="true" /> if managed resources should be disposed; otherwise, <see langword="false" />.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.InitializeComponent">\r
+ <summary>\r
+ Required method for Designer support - do not modify\r
+ the contents of this method with the code editor.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.#ctor">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.#ctor(System.ComponentModel.IContainer)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class, adding it to the specified container.\r
+ </summary>\r
+ <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to which the component should be added.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.Show">\r
+ <summary>\r
+ Displays the progress dialog as a modeless dialog.\r
+ </summary>\r
+ <remarks>\r
+ <para>\r
+ This function will not block the parent window and will return immediately.\r
+ </para>\r
+ <para>\r
+ Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog\r
+ will not function correctly unless the UI thread continues to handle window messages, so that thread may\r
+ not be blocked by some other activity. All processing related to the progress dialog must be done in\r
+ the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.\r
+ </para>\r
+ </remarks>\r
+ <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property\r
+ could not be loaded.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.Show(System.Object)">\r
+ <summary>\r
+ Displays the progress dialog as a modeless dialog.\r
+ </summary>\r
+ <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>\r
+ <remarks>\r
+ <para>\r
+ This function will not block the parent window and return immediately.\r
+ </para>\r
+ <para>\r
+ Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog\r
+ will not function correctly unless the UI thread continues to handle window messages, so that thread may\r
+ not be blocked by some other activity. All processing related to the progress dialog must be done in\r
+ the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.\r
+ </para>\r
+ </remarks>\r
+ <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property\r
+ could not be loaded.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.ShowDialog">\r
+ <summary>\r
+ Displays the progress dialog as a modal dialog.\r
+ </summary>\r
+ <remarks>\r
+ <para>\r
+ The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However,\r
+ the <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> function for the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class will return immediately.\r
+ The parent window will be disabled as with all modal dialogs.\r
+ </para>\r
+ <para>\r
+ Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog\r
+ will not function correctly unless the UI thread continues to handle window messages, so that thread may\r
+ not be blocked by some other activity. All processing related to the progress dialog must be done in\r
+ the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.\r
+ </para>\r
+ <para>\r
+ The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs,\r
+ but is part of the underlying native progress dialog API so cannot be avoided.\r
+ </para>\r
+ <para>\r
+ When possible, it is recommended that you use a modeless dialog using the <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> function.\r
+ </para>\r
+ </remarks>\r
+ <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property\r
+ could not be loaded.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.ShowDialog(System.Windows.Forms.IWin32Window)">\r
+ <summary>\r
+ Displays the progress dialog as a modal dialog.\r
+ </summary>\r
+ <param name="owner">The window that owns the dialog.</param>\r
+ <remarks>\r
+ <para>\r
+ The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However,\r
+ the <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> function for the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class will return immediately.\r
+ The parent window will be disabled as with all modal dialogs.\r
+ </para>\r
+ <para>\r
+ Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog\r
+ will not function correctly unless the UI thread continues to handle window messages, so that thread may\r
+ not be blocked by some other activity. All processing related to the progress dialog must be done in\r
+ the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.\r
+ </para>\r
+ <para>\r
+ The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs,\r
+ but is part of the underlying native progress dialog API so cannot be avoided.\r
+ </para>\r
+ <para>\r
+ When possible, it is recommended that you use a modeless dialog using the <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> function.\r
+ </para>\r
+ </remarks>\r
+ <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property\r
+ could not be loaded, or the operation is already running.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.ShowDialog(System.Windows.Forms.IWin32Window,System.Object)">\r
+ <summary>\r
+ Displays the progress dialog as a modal dialog.\r
+ </summary>\r
+ <param name="owner">The window that owns the dialog.</param>\r
+ <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>\r
+ <remarks>\r
+ <para>\r
+ The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However,\r
+ the <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> function for the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class will return immediately.\r
+ The parent window will be disabled as with all modal dialogs.\r
+ </para>\r
+ <para>\r
+ Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog\r
+ will not function correctly unless the UI thread continues to handle window messages, so that thread may\r
+ not be blocked by some other activity. All processing related to the progress dialog must be done in\r
+ the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.\r
+ </para>\r
+ <para>\r
+ The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs,\r
+ but is part of the underlying native progress dialog API so cannot be avoided.\r
+ </para>\r
+ <para>\r
+ When possible, it is recommended that you use a modeless dialog using the <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> function.\r
+ </para>\r
+ </remarks>\r
+ <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property\r
+ could not be loaded, or the operation is already running.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32)">\r
+ <summary>\r
+ Updates the dialog's progress bar.\r
+ </summary>\r
+ <param name="percentProgress">The percentage, from 0 to 100, of the operation that is complete.</param>\r
+ <remarks>\r
+ <para>\r
+ Call this method from the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler if you want to report progress.\r
+ </para>\r
+ <para>\r
+ This method has no effect is <see cref="P:Ookii.Dialogs.ProgressDialog.ProgressBarStyle"/> is <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>\r
+ or <see cref="F:Ookii.Dialogs.ProgressBarStyle.None"/>.\r
+ </para>\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="percentProgress"/> is out of range.</exception>\r
+ <exception cref="T:System.InvalidOperationException">The progress dialog is not currently being displayed.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)">\r
+ <summary>\r
+ Updates the dialog's progress bar.\r
+ </summary>\r
+ <param name="percentProgress">The percentage, from 0 to 100, of the operation that is complete.</param>\r
+ <param name="text">The new value of the progress dialog's primary text message, or <see langword="null"/> to leave the value unchanged.</param>\r
+ <param name="description">The new value of the progress dialog's additional description message, or <see langword="null"/> to leave the value unchanged.</param>\r
+ <remarks>Call this method from the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler if you want to report progress.</remarks>\r
+ <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="percentProgress"/> is out of range.</exception>\r
+ <exception cref="T:System.InvalidOperationException">The progress dialog is not currently being displayed.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String,System.Object)">\r
+ <summary>\r
+ Updates the dialog's progress bar.\r
+ </summary>\r
+ <param name="percentProgress">The percentage, from 0 to 100, of the operation that is complete.</param>\r
+ <param name="text">The new value of the progress dialog's primary text message, or <see langword="null"/> to leave the value unchanged.</param>\r
+ <param name="description">The new value of the progress dialog's additional description message, or <see langword="null"/> to leave the value unchanged.</param>\r
+ <param name="userState">A state object that will be passed to the <see cref="E:Ookii.Dialogs.ProgressDialog.ProgressChanged"/> event handler.</param>\r
+ <remarks>Call this method from the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler if you want to report progress.</remarks>\r
+ <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="percentProgress"/> is out of range.</exception>\r
+ <exception cref="T:System.InvalidOperationException">The progress dialog is not currently being displayed.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.OnDoWork(System.ComponentModel.DoWorkEventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:System.ComponentModel.DoWorkEventArgs"/> containing data for the event.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.OnRunWorkerCompleted(System.ComponentModel.RunWorkerCompletedEventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.ProgressDialog.RunWorkerCompleted"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ProgressDialog.OnProgressChanged(System.ComponentModel.ProgressChangedEventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.ProgressDialog.ProgressChanged"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:System.ComponentModel.ProgressChangedEventArgs"/> containing data for the event.</param>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.ProgressDialog.DoWork">\r
+ <summary>\r
+ Event raised when the dialog is displayed.\r
+ </summary>\r
+ <remarks>\r
+ Use this event to perform the operation that the dialog is showing the progress for.\r
+ This event will be raised on a different thread than the UI thread.\r
+ </remarks>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.ProgressDialog.RunWorkerCompleted">\r
+ <summary>\r
+ Event raised when the operation completes.\r
+ </summary>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.ProgressDialog.ProgressChanged">\r
+ <summary>\r
+ Event raised when <see cref="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String,System.Object)"/> is called.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ProgressDialog.WindowTitle">\r
+ <summary>\r
+ Gets or sets the text in the progress dialog's title bar.\r
+ </summary>\r
+ <value>\r
+ The text in the progress dialog's title bar. The default value is an empty string.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ 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\r
+ no effect while the dialog is being displayed.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ProgressDialog.Text">\r
+ <summary>\r
+ Gets or sets a short description of the operation being carried out.\r
+ </summary>\r
+ <value>\r
+ A short description of the operation being carried. The default value is an empty string.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ This is the primary message to the user.\r
+ </para>\r
+ <para>\r
+ This property can be changed while the dialog is running, but may only be changed from the thread which\r
+ created the progress dialog. The recommended method to change this value while the dialog is running\r
+ is to use the <see cref="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)"/> method.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ProgressDialog.UseCompactPathsForText">\r
+ <summary>\r
+ Gets or sets a value that indicates whether path strings in the <see cref="P:Ookii.Dialogs.ProgressDialog.Text"/> property should be compacted if\r
+ they are too large to fit on one line.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> to compact path strings if they are too large to fit on one line; otherwise,\r
+ <see langword="false"/>. The default value is <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ <note>\r
+ This property requires Windows Vista or later. On older versions of Windows, it has no effect.\r
+ </note>\r
+ <para>\r
+ This property can be changed while the dialog is running, but may only be changed from the thread which\r
+ created the progress dialog.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ProgressDialog.Description">\r
+ <summary>\r
+ Gets or sets additional details about the operation being carried out.\r
+ </summary>\r
+ <value>\r
+ Additional details about the operation being carried out. The default value is an empty string.\r
+ </value>\r
+ <remarks>\r
+ This text is used to provide additional details beyond the <see cref="P:Ookii.Dialogs.ProgressDialog.Text"/> property.\r
+ </remarks>\r
+ <remarks>\r
+ <para>\r
+ This property can be changed while the dialog is running, but may only be changed from the thread which\r
+ created the progress dialog. The recommended method to change this value while the dialog is running\r
+ is to use the <see cref="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)"/> method.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ProgressDialog.UseCompactPathsForDescription">\r
+ <summary>\r
+ Gets or sets a value that indicates whether path strings in the <see cref="P:Ookii.Dialogs.ProgressDialog.Description"/> property should be compacted if\r
+ they are too large to fit on one line.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> to compact path strings if they are too large to fit on one line; otherwise,\r
+ <see langword="false"/>. The default value is <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ <note>\r
+ This property requires Windows Vista or later. On older versions of Windows, it has no effect.\r
+ </note>\r
+ <para>\r
+ This property can be changed while the dialog is running, but may only be changed from the thread which\r
+ created the progress dialog.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ProgressDialog.CancellationText">\r
+ <summary>\r
+ Gets or sets the text that will be shown after the Cancel button is pressed.\r
+ </summary>\r
+ <value>\r
+ The text that will be shown after the Cancel button is pressed.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ 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\r
+ no effect while the dialog is being displayed.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ProgressDialog.ShowTimeRemaining">\r
+ <summary>\r
+ Gets or sets a value that indicates whether an estimate of the remaining time will be shown.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if an estimate of remaining time will be shown; otherwise, <see langword="false"/>. The\r
+ default value is <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ 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\r
+ no effect while the dialog is being displayed.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ProgressDialog.ShowCancelButton">\r
+ <summary>\r
+ Gets or sets a value that indicates whether the dialog has a cancel button.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the dialog has a cancel button; otherwise, <see langword="false"/>. The default\r
+ value is <see langword="true"/>.\r
+ </value>\r
+ <remarks>\r
+ <note>\r
+ This property requires Windows Vista or later; on older versions of Windows, the cancel button will always\r
+ be displayed.\r
+ </note>\r
+ <para>\r
+ The event handler for the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event must periodically check the value of the\r
+ <see cref="P:Ookii.Dialogs.ProgressDialog.CancellationPending"/> property to see if the operation has been cancelled if this\r
+ property is <see langword="true"/>.\r
+ </para>\r
+ <para>\r
+ Setting this property to <see langword="false"/> is not recommended unless absolutely necessary.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ProgressDialog.MinimizeBox">\r
+ <summary>\r
+ Gets or sets a value that indicates whether the progress dialog has a minimize button.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the dialog has a minimize button; otherwise, <see langword="false"/>. The default\r
+ value is <see langword="true"/>.\r
+ </value>\r
+ <remarks>\r
+ <note>\r
+ This property has no effect on modal dialogs (which do not have a minimize button). It only applies\r
+ to modeless dialogs shown by using the <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> method.\r
+ </note>\r
+ <para>\r
+ This property must be set before <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> is called. Changing property has\r
+ no effect while the dialog is being displayed.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ProgressDialog.CancellationPending">\r
+ <summary>\r
+ Gets a value indicating whether the user has requested cancellation of the operation.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the user has cancelled the progress dialog; otherwise, <see langword="false"/>. The default is <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ The event handler for the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event must periodically check this property and abort the operation\r
+ if it returns <see langword="true"/>.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ProgressDialog.Animation">\r
+ <summary>\r
+ Gets or sets the animation to show on the progress dialog.\r
+ </summary>\r
+ <value>\r
+ An instance of <see cref="T:Ookii.Dialogs.AnimationResource"/> which specifies the animation to show, or <see langword="null"/>\r
+ to show no animation. The default value is <see langword="null"/>.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ This property has no effect on Windows Vista or later. On Windows XP, this property will default to\r
+ a flying papers animation.\r
+ </para>\r
+ <para>\r
+ 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\r
+ no effect while the dialog is being displayed.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ProgressDialog.ProgressBarStyle">\r
+ <summary>\r
+ Gets or sets a value that indicates whether a regular or marquee style progress bar should be used.\r
+ </summary>\r
+ <value>\r
+ One of the values of <see cref="T:Ookii.Dialogs.ProgressBarStyle"/>. \r
+ The default value is <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.\r
+ </value>\r
+ <remarks>\r
+ <note>\r
+ Operating systems older than Windows Vista do not support marquee progress bars on the progress dialog. On those operating systems, the\r
+ progress bar will be hidden completely if this property is <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>.\r
+ </note>\r
+ <para>\r
+ 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\r
+ the value of the progress bar. When this property is set to <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>\r
+ 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,\r
+ but the percentage will be ignored.\r
+ </para>\r
+ <para>\r
+ 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\r
+ no effect while the dialog is being displayed.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ProgressDialog.IsBusy">\r
+ <summary>\r
+ Gets a value that indicates whether the <see cref="T:Ookii.Dialogs.ProgressDialog"/> is running an asynchronous operation.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the <see cref="T:Ookii.Dialogs.ProgressDialog"/> is running an asynchronous operation; \r
+ otherwise, <see langword="false"/>.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.AdditionalVisualStyleElements">\r
+ <summary>\r
+ Contains classes that provide additional visual style elements not available through the regular\r
+ <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> class.\r
+ </summary>\r
+ <threadsafety instance="false" static="false"/>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.AdditionalVisualStyleElements.TextStyle">\r
+ <summary>\r
+ Provides <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> objects for\r
+ text styles.\r
+ </summary>\r
+ <remarks>\r
+ <note>\r
+ Use of these styles requires Windows Vista or a newer version of Windows.\r
+ </note>\r
+ </remarks>\r
+ <threadsafety instance="false" static="false"/>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.AdditionalVisualStyleElements.TextStyle.MainInstruction">\r
+ <summary>\r
+ Gets a visual style element that represents the main instruction in a dialog box.\r
+ </summary>\r
+ <value>\r
+ A <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> representing the style for the main instruction.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.AdditionalVisualStyleElements.TextStyle.BodyText">\r
+ <summary>\r
+ Gets a visual style element that represents the body text in a dialog box.\r
+ </summary>\r
+ <value>\r
+ A <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> representing the style for the body text.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.AdditionalVisualStyleElements.TaskDialog">\r
+ <summary>\r
+ Provides <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> objects\r
+ for task dialog related elements.\r
+ </summary>\r
+ <remarks>\r
+ <note>\r
+ Use of these styles requires Windows Vista or a newer version of Windows.\r
+ </note>\r
+ </remarks>\r
+ <threadsafety instance="false" static="false"/>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.AdditionalVisualStyleElements.TaskDialog.PrimaryPanel">\r
+ <summary>\r
+ Gets a visual style element that represents the primary panel of a task dialog.\r
+ </summary>\r
+ <value>\r
+ A <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> representing the style for the primary panel.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.AdditionalVisualStyleElements.TaskDialog.SecondaryPanel">\r
+ <summary>\r
+ Gets a visual style element that represents the secondary panel of a task dialog.\r
+ </summary>\r
+ <value>\r
+ A <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> representing the style for the secondary panel.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.TaskDialogItem">\r
+ <summary>\r
+ Represents a button or radio button on a task dialog.\r
+ </summary>\r
+ <threadsafety instance="false" static="true" />\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.TaskDialogItem.components">\r
+ <summary>\r
+ Required designer variable.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogItem.Dispose(System.Boolean)">\r
+ <summary> \r
+ Clean up any resources being used.\r
+ </summary>\r
+ <param name="disposing"><see langword="true"/> if managed resources should be disposed; otherwise, <see langword="false"/>.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogItem.InitializeComponent">\r
+ <summary>\r
+ Required method for Designer support - do not modify\r
+ the contents of this method with the code editor.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogItem.#ctor">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogItem.#ctor(System.ComponentModel.IContainer)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> class with the specified container.\r
+ </summary>\r
+ <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> to.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogItem.Click">\r
+ <summary>\r
+ Simulates a click on the task dialog item.\r
+ </summary>\r
+ <remarks>\r
+ This method is available only while the task dialog is being displayed. You would typically call\r
+ it from one of the events fired by the <see cref="T:Ookii.Dialogs.TaskDialog"/> class while the dialog is visible.\r
+ </remarks>\r
+ <exception cref="T:System.InvalidOperationException">\r
+ <para>The task dialog is not being displayed</para>\r
+ <para>-or-</para>\r
+ <para>The item has no associated task dialog.</para>\r
+ </exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogItem.UpdateOwner">\r
+ <summary>\r
+ Causes a full update of the owner dialog.\r
+ </summary>\r
+ <remarks>\r
+ <para>\r
+ When this method is called, the owner dialog will be updated to reflect the\r
+ current state of the object.\r
+ </para>\r
+ <para>\r
+ When the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> has no owner, or the owner is not being\r
+ displayed, this method has no effect.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialogItem.Owner">\r
+ <summary>\r
+ Gets the <see cref="T:Ookii.Dialogs.TaskDialog"/> that owns this <see cref="T:Ookii.Dialogs.TaskDialogItem"/>.\r
+ </summary>\r
+ <value>\r
+ The <see cref="T:Ookii.Dialogs.TaskDialog"/> that owns this <see cref="T:Ookii.Dialogs.TaskDialogItem"/>.\r
+ </value>\r
+ <remarks>\r
+ This property is set automatically when the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> is added\r
+ to the <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/> or <see cref="P:Ookii.Dialogs.TaskDialog.RadioButtons"/>\r
+ collection of a <see cref="T:Ookii.Dialogs.TaskDialog"/>.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialogItem.Text">\r
+ <summary>\r
+ Gets or sets the text of the item.\r
+ </summary>\r
+ <value>\r
+ The text of the item. The default value is an empty string ("").\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ For buttons, this property is ignored if <see cref="P:Ookii.Dialogs.TaskDialogButton.ButtonType"/> is any value other \r
+ than <see cref="F:Ookii.Dialogs.ButtonType.Custom"/>.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialogItem.Enabled">\r
+ <summary>\r
+ Gets or sets a value that indicates whether the item is enabled.\r
+ </summary>\r
+ <value>\r
+ <see langword="true" /> if this item is enabled; otherwise, <see langword="false" />.\r
+ </value>\r
+ <remarks>\r
+ If a button or radio button is not enabled, it will be grayed out and cannot be\r
+ selected or clicked.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialogItem.Id">\r
+ <summary>\r
+ Gets or sets the ID of the item.\r
+ </summary>\r
+ <value>\r
+ The unique identifier of the item.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ The identifier of an item must be unique for the type of item on the task dialog (i.e. no two\r
+ buttons can have the same id, no two radio buttons can have the same id, but a radio button\r
+ can have the same id as a button).\r
+ </para>\r
+ <para>\r
+ If this property is zero when the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> is added to the <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/>\r
+ or <see cref="P:Ookii.Dialogs.TaskDialog.RadioButtons"/> collection of a task dialog, it will automatically be set\r
+ to the next available id value.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialogItem.ItemCollection">\r
+ <summary>\r
+ When implemented in a derived class, gets the item collection on a task dialog that this type of item is\r
+ part of.\r
+ </summary>\r
+ <value>\r
+ For <see cref="T:Ookii.Dialogs.TaskDialogButton"/> items, the <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/>\r
+ 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"/>\r
+ 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\r
+ currently associated with a <see cref="T:Ookii.Dialogs.TaskDialog"/>, <see langword="null"/>.\r
+ </value>\r
+ <remarks>\r
+ The collection returned by this property is used to determine if there are any items with duplicate IDs.\r
+ </remarks>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.ProgressBarStyle">\r
+ <summary>\r
+ Indicates the type of progress on a task dialog.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ProgressBarStyle.None">\r
+ <summary>\r
+ No progress bar is displayed on the dialog.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar">\r
+ <summary>\r
+ A regular progress bar is displayed on the dialog.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar">\r
+ <summary>\r
+ A marquee progress bar is displayed on the dialog. Use this value for operations\r
+ that cannot report concrete progress information.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.OkButtonClickedEventArgs">\r
+ <summary>\r
+ Provides data for the <see cref="E:Ookii.Dialogs.InputDialog.OkButtonClicked"/> event.\r
+ </summary>\r
+ <threadsafety instance="false" static="true"/>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.OkButtonClickedEventArgs.#ctor(System.String,System.Windows.Forms.IWin32Window)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.OkButtonClickedEventArgs"/> class with the specified input text\r
+ and input box window.\r
+ </summary>\r
+ <param name="input">The current value of the input field on the dialog.</param>\r
+ <param name="inputBoxWindow">The input box window.</param>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.OkButtonClickedEventArgs.Input">\r
+ <summary>\r
+ Gets the current value of the input field on the dialog.\r
+ </summary>\r
+ <value>\r
+ The current value of the input field on the dialog.\r
+ </value>\r
+ <remarks>\r
+ The <see cref="P:Ookii.Dialogs.InputDialog.Input"/> property will not be updated until the dialog has been closed,\r
+ so this property can be used to determine the value entered by the user when this event is raised.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.OkButtonClickedEventArgs.InputBoxWindow">\r
+ <summary>\r
+ Gets the input box window.\r
+ </summary>\r
+ <value>\r
+ The <see cref="T:System.Windows.Forms.IWin32Window"/> for the input box window.\r
+ </value>\r
+ <remarks>\r
+ You can use this property if you need to display a modal dialog (for example to alert the user if the current input value\r
+ is invalid) and you want the input box to be the parent of that dialog.\r
+ </remarks>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.InputDialog">\r
+ <summary>\r
+ Represents a dialog that allows the user to input a single text value.\r
+ </summary>\r
+ <remarks>\r
+ Using a modal dialog to ask the user for input is not often the best design decision. Carefully\r
+ evaluate alternative methods, such as in-place editing, if applicable, before using this dialog.\r
+ </remarks>\r
+ <threadsafety instance="false" static="true" />\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.InputDialog.#ctor">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.InputDialog"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.InputDialog.#ctor(System.ComponentModel.IContainer)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.InputDialog"/> class, adding it to the specified container.\r
+ </summary>\r
+ <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the component to.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.InputDialog.OnInputChanged(System.EventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.InputDialog.InputChanged"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.InputDialog.OnOkButtonClicked(Ookii.Dialogs.OkButtonClickedEventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.InputDialog.OkButtonClicked"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:Ookii.Dialogs.OkButtonClickedEventArgs"/> containing data for the event.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.InputDialog.ShowDialog">\r
+ <summary>\r
+ Displays the input box as a modal dialog box.\r
+ </summary>\r
+ <returns>The <see cref="T:System.Windows.Forms.DialogResult"/> value that corresponds to the button the user clicked.</returns>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.InputDialog.ShowDialog(System.Windows.Forms.IWin32Window)">\r
+ <summary>\r
+ Displays the input box as a modal dialog box with the specified owner.\r
+ </summary>\r
+ <param name="owner">The <see cref="T:System.Windows.Forms.IWin32Window"/> that will be the owner of the dialog box.</param>\r
+ <returns>The <see cref="T:System.Windows.Forms.DialogResult"/></returns>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.InputDialog.components">\r
+ <summary>\r
+ Required designer variable.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.InputDialog.Dispose(System.Boolean)">\r
+ <summary> \r
+ Clean up any resources being used.\r
+ </summary>\r
+ <param name="disposing"><see langword="true" /> if managed resources should be disposed; otherwise, <see langword="false" />.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.InputDialog.InitializeComponent">\r
+ <summary>\r
+ Required method for Designer support - do not modify\r
+ the contents of this method with the code editor.\r
+ </summary>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.InputDialog.InputChanged">\r
+ <summary>\r
+ Event raised when the value of the <see cref="P:Ookii.Dialogs.InputDialog.Input"/> property changes.\r
+ </summary>\r
+ <remarks>\r
+ 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\r
+ the user is using the dialog.\r
+ </remarks>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.InputDialog.OkButtonClicked">\r
+ <summary>\r
+ Event raised when the user clicks the OK button on the dialog.\r
+ </summary>\r
+ <remarks>\r
+ Set the <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> property to <see langword="true"/> to prevent the dialog from closing.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.InputDialog.MainInstruction">\r
+ <summary>\r
+ Gets or sets the dialog's main instruction.\r
+ </summary>\r
+ <value>\r
+ The dialog's main instruction. The default value is an empty string ("").\r
+ </value>\r
+ <remarks>\r
+ 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\r
+ the other text of the input dialog. Otherwise, it will be shown in bold.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.InputDialog.Content">\r
+ <summary>\r
+ Gets or sets the dialog's primary content.\r
+ </summary>\r
+ <value>\r
+ The dialog's primary content. The default value is an empty string ("").\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.InputDialog.WindowTitle">\r
+ <summary>\r
+ Gets or sets the window title of the dialog.\r
+ </summary>\r
+ <value>\r
+ The window title of the dialog. The default is an empty string ("").\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.InputDialog.Input">\r
+ <summary>\r
+ Gets or sets the text specified by the user.\r
+ </summary>\r
+ <value>\r
+ The initial text of the input field, or the text specified by the user. The default vaue is an empty string ("").\r
+ </value>\r
+ <remarks>\r
+ Setting this property before calling <see cref="M:Ookii.Dialogs.InputDialog.ShowDialog"/> determines the initial text in the input field. Retrieving\r
+ the property after the user has clicked OK will return the text entered by the user.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.InputDialog.MaxLength">\r
+ <summary>\r
+ Gets or sets the maximum number of characters that can be entered into the input field of the dialog.\r
+ </summary>\r
+ <value>\r
+ The number of characters that can be entered into the input field. The default value is 32767.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.InputDialog.UsePasswordMasking">\r
+ <summary>\r
+ Gets or sets a value that indicates whether the input will be masked using the system password character.\r
+ </summary>\r
+ <value>\r
+ <see langword="true" /> if the input is masked; otherwise, <see langword="false" />. The default value is <see langword="false" />.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.InputDialog.BindingContext">\r
+ <summary>\r
+ Gets or sets the collection of currency managers for the <see cref="T:Ookii.Dialogs.InputDialog"/>.\r
+ </summary>\r
+ <value>\r
+ The collection of currency managers for the <see cref="T:Ookii.Dialogs.TaskDialog"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.InputDialog.DataBindings">\r
+ <summary>\r
+ Gets the collection of data-binding objects for this <see cref="T:Ookii.Dialogs.InputDialog"/>.\r
+ </summary>\r
+ <value>\r
+ The collection of data-binding objects for this <see cref="T:Ookii.Dialogs.TaskDialog"/>.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.CredentialException">\r
+ <summary>\r
+ The exception that is thrown when an error occurs getting credentials.\r
+ </summary>\r
+ <threadsafety instance="false" static="true" />\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialException.#ctor">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialException"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialException.#ctor(System.Int32)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialException"/> class with the specified error. \r
+ </summary>\r
+ <param name="error">The Win32 error code associated with this exception.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialException.#ctor(System.String)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialException"/> class with a specified error message.\r
+ </summary>\r
+ <param name="message">The message that describes the error.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialException.#ctor(System.Int32,System.String)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialException"/> class with the specified error and the specified detailed description.\r
+ </summary>\r
+ <param name="error">The Win32 error code associated with this exception.</param>\r
+ <param name="message">A detailed description of the error.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialException.#ctor(System.String,System.Exception)">\r
+ <summary>\r
+ 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.\r
+ </summary>\r
+ <param name="message">The error message that explains the reason for the exception.</param>\r
+ <param name="innerException">A reference to the inner exception that is the cause of the current exception.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialException"/> class with serialized data.\r
+ </summary>\r
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>\r
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.VistaOpenFileDialog">\r
+ <summary>\r
+ Prompts the user to open a file.\r
+ </summary>\r
+ <remarks>\r
+ <para>\r
+ This class will use the Vista style file dialog if possible, and automatically fall back to the old-style \r
+ dialog on versions of Windows older than Vista.\r
+ </para>\r
+ <para>\r
+ As of .Net 3.5 and .Net 2.0 SP1, the regular <see cref="T:System.Windows.Forms.OpenFileDialog"/> class will also use\r
+ the new Vista style dialogs. However, certain options, such as settings <see cref="P:System.Windows.Forms.OpenFileDialog.ShowReadOnly"/>,\r
+ still cause that class to revert to the old style dialogs. For this reason, this class is still provided.\r
+ It is recommended that you use the <see cref="T:System.Windows.Forms.FileDialog"/> class whenever possible.\r
+ </para>\r
+ </remarks>\r
+ <threadsafety static="true" instance="false"/>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.VistaFileDialog">\r
+ <summary>\r
+ Displays a dialog box from which the user can select a file.\r
+ </summary>\r
+ <remarks>\r
+ <para>\r
+ This class will use the Vista style file dialog if possible, and automatically fall back to the old-style \r
+ dialog on versions of Windows older than Vista.\r
+ </para>\r
+ <para>\r
+ As of .Net 3.5 and .Net 2.0 SP1, the regular <see cref="T:System.Windows.Forms.FileDialog"/> class will also use\r
+ the new Vista style dialogs. However, certain options, such as settings <see cref="P:System.Windows.Forms.OpenFileDialog.ShowReadOnly"/>,\r
+ still cause that class to revert to the old style dialogs. For this reason, this class is still provided.\r
+ It is recommended that you use the <see cref="T:System.Windows.Forms.FileDialog"/> class whenever possible.\r
+ </para>\r
+ </remarks>\r
+ <threadsafety static="true" instance="false"/>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaFileDialog.#ctor">\r
+ <summary>\r
+ Creates a new insatnce of <see cref="T:Ookii.Dialogs.VistaFileDialog"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaFileDialog.Reset">\r
+ <summary>\r
+ Resets all properties to their default values.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaFileDialog.RunDialog(System.IntPtr)">\r
+ <summary>\r
+ Specifies a common dialog box.\r
+ </summary>\r
+ <param name="hwndOwner">A value that represents the window handle of the owner window for the common dialog box.</param>\r
+ <returns><see langword="true"/> if the file could be opened; otherwise, <see langword="false"/>.</returns>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaFileDialog.OnFileOk(System.ComponentModel.CancelEventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.VistaFileDialog.FileOk"/> event.\r
+ </summary>\r
+ <param name="e">A <see cref="T:System.ComponentModel.CancelEventArgs"/> that contains the event data.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaFileDialog.Dispose(System.Boolean)">\r
+ <summary>\r
+ Releases the unmanaged resources used by the <see cref="T:Ookii.Dialogs.VistaFileDialog"/> and optionally releases the managed resources.\r
+ </summary>\r
+ <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.VistaFileDialog.FileOk">\r
+ <summary>\r
+ Occurs when the user clicks on the Open or Save button on a file dialog box.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.IsVistaFileDialogSupported">\r
+ <summary>\r
+ Gets a value that indicates whether the current OS supports Vista-style common file dialogs.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> on Windows Vista or newer operating systems; otherwise, <see langword="false"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.AddExtension">\r
+ <summary>\r
+ Gets or sets a value indicating whether the dialog box automatically adds an extension to a file name \r
+ if the user omits the extension.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the dialog box adds an extension to a file name if the user omits the extension; otherwise, <see langword="false"/>. \r
+ The default value is <see langword="true"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.CheckFileExists">\r
+ <summary>\r
+ Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.\r
+ </summary>\r
+ <value>\r
+ <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"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.CheckPathExists">\r
+ <summary>\r
+ Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a path that does not exist.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the dialog box displays a warning when the user specifies a path that does not exist; otherwise, <see langword="false"/>. \r
+ The default value is <see langword="true"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.DefaultExt">\r
+ <summary>\r
+ Gets or sets the default file name extension.\r
+ </summary>\r
+ <value>\r
+ The default file name extension. The returned string does not include the period. The default value is an empty string ("").\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.DereferenceLinks">\r
+ <summary>\r
+ Gets or sets a value indicating whether the dialog box returns the location of the file referenced by the shortcut \r
+ or whether it returns the location of the shortcut (.lnk).\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the dialog box returns the location of the file referenced by the shortcut; otherwise, <see langword="false"/>.\r
+ The default value is <see langword="true"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.FileName">\r
+ <summary>\r
+ Gets or sets a string containing the file name selected in the file dialog box.\r
+ </summary>\r
+ <value>\r
+ The file name selected in the file dialog box. The default value is an empty string ("").\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.FileNames">\r
+ <summary>\r
+ Gets the file names of all selected files in the dialog box.\r
+ </summary>\r
+ <value>\r
+ An array of type String, containing the file names of all selected files in the dialog box.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.Filter">\r
+ <summary>\r
+ Gets or sets the current file name filter string, which determines the choices that appear in the \r
+ "Save as file type" or "Files of type" box in the dialog box.\r
+ </summary>\r
+ <value>\r
+ The file filtering options available in the dialog box.\r
+ </value>\r
+ <exception cref="T:System.ArgumentException">Filter format is invalid.</exception>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.FilterIndex">\r
+ <summary>\r
+ Gets or sets the index of the filter currently selected in the file dialog box.\r
+ </summary>\r
+ <value>\r
+ A value containing the index of the filter currently selected in the file dialog box. The default value is 1.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.InitialDirectory">\r
+ <summary>\r
+ Gets or sets the initial directory displayed by the file dialog box.\r
+ </summary>\r
+ <value>\r
+ The initial directory displayed by the file dialog box. The default is an empty string ("").\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.RestoreDirectory">\r
+ <summary>\r
+ Gets or sets a value indicating whether the dialog box restores the current directory before closing.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the dialog box restores the current directory to its original value if the user changed the \r
+ directory while searching for files; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.ShowHelp">\r
+ <summary>\r
+ Gets or sets a value indicating whether the Help button is displayed in the file dialog box.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the dialog box includes a help button; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.Title">\r
+ <summary>\r
+ Gets or sets the file dialog box title.\r
+ </summary>\r
+ <value>\r
+ The file dialog box title. The default value is an empty string ("").\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.SupportMultiDottedExtensions">\r
+ <summary>\r
+ Gets or sets whether the dialog box supports displaying and saving files that have multiple file name extensions.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the dialog box supports multiple file name extensions; otherwise, <see langword="false"/>. The default is <see langword="false"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.ValidateNames">\r
+ <summary>\r
+ Gets or sets a value indicating whether the dialog box accepts only valid Win32 file names.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the dialog box accepts only valid Win32 file names; otherwise, <see langword="false"/>. The default value is <see langword="true"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFileDialog.DownlevelDialog">\r
+ <summary>\r
+ Gets or sets the downlevel file dialog which is to be used if the Vista-style\r
+ dialog is not supported.\r
+ </summary>\r
+ <value>\r
+ The downlevel file dialog which is to be used if the Vista-style\r
+ dialog is not supported.\r
+ </value>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaOpenFileDialog.#ctor">\r
+ <summary>\r
+ Creates a new instance of <see cref="T:Ookii.Dialogs.VistaOpenFileDialog"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaOpenFileDialog.#ctor(System.Boolean)">\r
+ <summary>\r
+ Creates a new instance of <see cref="T:Ookii.Dialogs.VistaOpenFileDialog"/> class.\r
+ </summary>\r
+ <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>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaOpenFileDialog.Reset">\r
+ <summary>\r
+ Resets all properties to their default values.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaOpenFileDialog.OpenFile">\r
+ <summary>\r
+ Opens the file selected by the user, with read-only permission. The file is specified by the FileName property. \r
+ </summary>\r
+ <returns>A Stream that specifies the read-only file selected by the user.</returns>\r
+ <exception cref="T:System.ArgumentNullException">The file name is <see langword="null"/>.</exception>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaOpenFileDialog.CheckFileExists">\r
+ <summary>\r
+ Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.\r
+ </summary>\r
+ <value>\r
+ <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"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaOpenFileDialog.Multiselect">\r
+ <summary>\r
+ Gets or sets a value indicating whether the dialog box allows multiple files to be selected.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the dialog box allows multiple files to be selected together or concurrently; otherwise, <see langword="false"/>. \r
+ The default value is <see langword="false"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaOpenFileDialog.ShowReadOnly">\r
+ <summary>\r
+ Gets or sets a value indicating whether the dialog box contains a read-only check box.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the dialog box contains a read-only check box; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ If the Vista style dialog is used, this property can only be used to determine whether the user chose\r
+ Open as read-only on the dialog; setting it in code will have no effect.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaOpenFileDialog.ReadOnlyChecked">\r
+ <summary>\r
+ Gets or sets a value indicating whether the read-only check box is selected.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the read-only check box is selected; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.TimerEventArgs">\r
+ <summary>\r
+ Provides data for the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event.\r
+ </summary>\r
+ <threadsafety instance="false" static="true"/>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TimerEventArgs.#ctor(System.Int32)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TimerEventArgs"/> class with the specified tick count.\r
+ </summary>\r
+ <param name="tickCount">The tick count.</param>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TimerEventArgs.ResetTickCount">\r
+ <summary>\r
+ Gets or sets a value that indicates whether the tick count should be reset.\r
+ </summary>\r
+ <value>\r
+ <see langword="true" /> to reset the tick count after the event handler returns; otherwise, <see langword="false" />.\r
+ The default value is <see langword="false" />.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TimerEventArgs.TickCount">\r
+ <summary>\r
+ Gets the current tick count of the timer.\r
+ </summary>\r
+ <value>\r
+ The number of milliseconds that has elapsed since the dialog was created or since the last time the event handler returned\r
+ with the <see cref="P:Ookii.Dialogs.TimerEventArgs.ResetTickCount"/> property set to <see langword="true"/>.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.TaskDialogItemClickedEventArgs">\r
+ <summary>\r
+ Provides data for the <see cref="E:Ookii.Dialogs.TaskDialog.ButtonClicked"/> event.\r
+ </summary>\r
+ <threadsafety instance="false" static="true"/>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogItemClickedEventArgs.#ctor(Ookii.Dialogs.TaskDialogItem)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogItemClickedEventArgs"/> class with the specified item.\r
+ </summary>\r
+ <param name="item">The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> that was clicked.</param>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialogItemClickedEventArgs.Item">\r
+ <summary>\r
+ Gets the item that was clicked.\r
+ </summary>\r
+ <value>\r
+ The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> that was clicked.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.TaskDialogButton">\r
+ <summary>\r
+ A button on a <see cref="T:Ookii.Dialogs.TaskDialog"/>.\r
+ </summary>\r
+ <threadsafety instance="false" static="true"/>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogButton.#ctor">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogButton.#ctor(Ookii.Dialogs.ButtonType)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> class with the specified button type.\r
+ </summary>\r
+ <param name="type">The type of the button.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogButton.#ctor(System.ComponentModel.IContainer)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> class with the specified container.\r
+ </summary>\r
+ <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> to.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogButton.#ctor(System.String)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> class with the specified text.\r
+ </summary>\r
+ <param name="text">The text of the button.</param>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialogButton.ButtonType">\r
+ <summary>\r
+ Gets or sets the type of the button.\r
+ </summary>\r
+ <value>\r
+ One of the <see cref="T:Ookii.Dialogs.ButtonType"/> values that indicates the type of the button. The default value\r
+ is <see cref="F:Ookii.Dialogs.ButtonType.Custom"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialogButton.CommandLinkNote">\r
+ <summary>\r
+ Gets or sets the text of the note associated with a command link button.\r
+ </summary>\r
+ <value>\r
+ The text of the note associated with a command link button.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ This property applies only to buttons where the <see cref="T:System.Type"/> property\r
+ is <see cref="F:Ookii.Dialogs.ButtonType.Custom"/>. For other button types, it is ignored.\r
+ </para>\r
+ <para>\r
+ In addition, it is used only if the <see cref="P:Ookii.Dialogs.TaskDialog.ButtonStyle"/> property is set to\r
+ <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinks"/> or <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinksNoIcon"/>;\r
+ otherwise, it is ignored.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialogButton.Default">\r
+ <summary>\r
+ Gets or sets a value that indicates if the button is the default button on the dialog.\r
+ </summary>\r
+ <value><see langword="true" /> if the button is the default button; otherwise, <see langword="false" />.\r
+ The default value is <see langword="false" />.</value>\r
+ <remarks>\r
+ If no button has this property set to <see langword="true" />, the first button on the dialog will be the default button.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialogButton.ElevationRequired">\r
+ <summary>\r
+ Gets or sets a value that indicates whether the Task Dialog button or command link should have a \r
+ User Account Control (UAC) shield icon (in other words, whether the action invoked by the \r
+ button requires elevation). \r
+ </summary>\r
+ <value>\r
+ <see langword="true" /> if the button contains a UAC shield icon; otherwise, <see langword="false" />.\r
+ </value>\r
+ <remarks>\r
+ Elevation is not performed by the task dialog; the code implementing the operation that results from\r
+ the button being clicked is responsible for performing elevation if required.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialogButton.ItemCollection">\r
+ <summary>\r
+ Gets the collection that items of this type are part of.\r
+ </summary>\r
+ <value>\r
+ If the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> is currently associated with a <see cref="T:Ookii.Dialogs.TaskDialog"/>, the\r
+ <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/> collection of that <see cref="T:Ookii.Dialogs.TaskDialog"/>; otherwise, <see langword="null"/>.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.Properties.Resources">\r
+ <summary>\r
+ A strongly-typed resource class, for looking up localized strings, etc.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.ResourceManager">\r
+ <summary>\r
+ Returns the cached ResourceManager instance used by this class.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.Culture">\r
+ <summary>\r
+ Overrides the current thread's CurrentUICulture property for all\r
+ resource lookups using this strongly typed resource class.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.AnimationLoadErrorFormat">\r
+ <summary>\r
+ Looks up a localized string similar to Unable to load the progress dialog animation: {0}.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.CredentialEmptyTargetError">\r
+ <summary>\r
+ Looks up a localized string similar to The credential target may not be an empty string..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.CredentialError">\r
+ <summary>\r
+ Looks up a localized string similar to An error occurred acquiring credentials..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.CredentialPromptNotCalled">\r
+ <summary>\r
+ Looks up a localized string similar to PromptForCredentialsWithSave has not been called or the credentials were modified after the call..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.DuplicateButtonTypeError">\r
+ <summary>\r
+ Looks up a localized string similar to The task dialog already has a non-custom button with the same type..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.DuplicateItemIdError">\r
+ <summary>\r
+ Looks up a localized string similar to The task dialog already has an item with the same id..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.FileNotFoundFormat">\r
+ <summary>\r
+ Looks up a localized string similar to The file "{0}" could not be found..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.GlassNotSupportedError">\r
+ <summary>\r
+ Looks up a localized string similar to The current operating system does not support glass, or the Desktop Window Manager is not enabled..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.Help">\r
+ <summary>\r
+ Looks up a localized string similar to Help.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.InvalidFilterString">\r
+ <summary>\r
+ Looks up a localized string similar to Invalid filter string,.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.InvalidTaskDialogItemIdError">\r
+ <summary>\r
+ Looks up a localized string similar to The id of a task dialog item must be higher than 0..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.NoAssociatedTaskDialogError">\r
+ <summary>\r
+ Looks up a localized string similar to The item is not associated with a task dialog..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.NonCustomTaskDialogButtonIdError">\r
+ <summary>\r
+ Looks up a localized string similar to Cannot change the id for a standard button..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.Preview">\r
+ <summary>\r
+ Looks up a localized string similar to Preview.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.ProgressDialogNotRunningError">\r
+ <summary>\r
+ Looks up a localized string similar to The progress dialog is not shown..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.ProgressDialogRunning">\r
+ <summary>\r
+ Looks up a localized string similar to The progress dialog is already running..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogEmptyButtonLabelError">\r
+ <summary>\r
+ Looks up a localized string similar to A custom button or radio button cannot have an empty label..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogIllegalCrossThreadCallError">\r
+ <summary>\r
+ 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..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogItemHasOwnerError">\r
+ <summary>\r
+ Looks up a localized string similar to The task dialog item already belongs to another task dialog..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogNoButtonsError">\r
+ <summary>\r
+ Looks up a localized string similar to The task dialog must have buttons..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogNotRunningError">\r
+ <summary>\r
+ Looks up a localized string similar to The task dialog is not current displayed..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogRunningError">\r
+ <summary>\r
+ Looks up a localized string similar to The task dialog is already being displayed..\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogsNotSupportedError">\r
+ <summary>\r
+ Looks up a localized string similar to The operating system does not support task dialogs..\r
+ </summary>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.Glass">\r
+ <summary>\r
+ Provides functionality to use Aero Glass.\r
+ </summary>\r
+ <remarks>\r
+ <para>\r
+ This class provides functionality to extend the Windows Vista Aero glass window frame into a window's\r
+ client area, and to draw text on the glass area.\r
+ </para>\r
+ <para>\r
+ The <see cref="T:Ookii.Dialogs.ExtendedForm"/> class provides more comprehensive support for client area glass than\r
+ 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. \r
+ In addition to the basic client area glass support, <see cref="T:Ookii.Dialogs.ExtendedForm"/> will also\r
+ respond to changes in the Desktop Window Manager state and enable/disable client area glass as necessary. It also\r
+ allows the window to be dragged using the client area glass areas using the <see cref="P:Ookii.Dialogs.ExtendedForm.AllowGlassDragging"/>\r
+ property.\r
+ </para>\r
+ <note>\r
+ Use of glass requires Windows Vista or later with the Desktop Window Manager enabled.\r
+ </note>\r
+ </remarks>\r
+ <threadsafety instance="false" static="true"/>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.Glass.ExtendFrameIntoClientArea(System.Windows.Forms.IWin32Window,System.Windows.Forms.Padding)">\r
+ <summary>\r
+ Extends the glass window frame into the client area of the specified window.\r
+ </summary>\r
+ <param name="window">The <see cref="T:System.Windows.Forms.IWin32Window"/> on which to enable client area glass.</param>\r
+ <param name="glassMargin">The the margins to use when extending the frame into the client area.</param>\r
+ <remarks>\r
+ <para>\r
+ Use negative margins to create the "sheet of glass" effect where the client area is rendered \r
+ as a completely glass surface.\r
+ </para>\r
+ <para>\r
+ The glass area must be filled with either a black brush or the <see cref="P:System.Windows.Forms.Form.TransparencyKey"/> color\r
+ in order to display correctly. If the <see cref="P:System.Windows.Forms.Form.TransparencyKey"/> method is used, clicks in the\r
+ glass area will "fall through" the window to the window below it. If the black brush method is used, text\r
+ rendered with the <see cref="T:System.Windows.Forms.TextRenderer"/> will not display correctly on the glass area (this includes\r
+ 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)"/>.\r
+ </para>\r
+ <para>\r
+ This method needs to be called again if the state of the Desktop Window Manager is toggled.\r
+ </para>\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentNullException"><paramref name="window"/> is <see langword="null"/>.</exception>\r
+ <exception cref="T:System.NotSupportedException">The current operating system does not support glass, or the Desktop Window Manager is not enabled.</exception>\r
+ </member>\r
+ <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)">\r
+ <summary>\r
+ Draws composited text onto the glass area of a form.\r
+ </summary>\r
+ <param name="dc">The <see cref="T:System.Drawing.IDeviceContext"/> onto which the composited text should be drawn.</param>\r
+ <param name="text">The text to draw.</param>\r
+ <param name="font">The <see cref="T:System.Drawing.Font"/> to apply to the drawn text.</param>\r
+ <param name="bounds">The <see cref="T:System.Drawing.Rectangle"/> that represents the bounds of the text.</param>\r
+ <param name="padding">The <see cref="T:System.Windows.Forms.Padding"/> around the text; necessary to allow space for the glow effect.</param>\r
+ <param name="foreColor">The <see cref="T:System.Drawing.Color"/> to apply to the drawn text.</param>\r
+ <param name="textFormat">A bitwise combination of the <see cref="T:System.Windows.Forms.TextFormatFlags"/> values.</param>\r
+ <param name="glowSize">Specifies the size of a glow that will be drawn on the background prior to any text being drawn.</param>\r
+ <remarks>\r
+ <para>\r
+ Do not use this method to draw text on non-glass areas of a form.\r
+ </para>\r
+ </remarks>\r
+ <exception cref="T:System.NotSupportedException">The current operating system does not support glass, or the Desktop Window Manager is not enabled.</exception>\r
+ <exception cref="T:System.ArgumentNullException"><paramref name="dc"/>, <paramref name="text"/> or <paramref name="font"/> is <see langword="null"/>.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.Glass.MeasureCompositedText(System.Drawing.IDeviceContext,System.String,System.Drawing.Font,System.Windows.Forms.TextFormatFlags)">\r
+ <summary>\r
+ Provides the size, in pixels, of the specified text.\r
+ </summary>\r
+ <param name="dc">The device context in which to measure the text.</param>\r
+ <param name="text">The text to measure.</param>\r
+ <param name="font">The <see cref="T:System.Drawing.Font"/> to apply to the measured text.</param>\r
+ <param name="textFormat">A bitwise combination of the <see cref="T:System.Windows.Forms.TextFormatFlags"/> values.</param>\r
+ <returns>The <see cref="T:System.Drawing.Size"/>, in pixels, of <paramref name="text"/> drawn with the specified <paramref name="font"/> and format.</returns>\r
+ <exception cref="T:System.NotSupportedException">The current operating system does not support glass, or the Desktop Window Manager is not enabled.</exception>\r
+ <exception cref="T:System.ArgumentNullException"><paramref name="dc"/>, <paramref name="text"/> or <paramref name="font"/> is <see langword="null"/>.</exception>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Glass.OSSupportsDwmComposition">\r
+ <summary>\r
+ Gets a value that indicates whether the operating system supports composition through the Desktop Window Manager.\r
+ </summary>\r
+ <value>\r
+ <see langword="true" /> on operating systems that support the Desktop Window Manager (Windows Vista and higher); otherwise, <see langword="false" />.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.Glass.IsDwmCompositionEnabled">\r
+ <summary>\r
+ Gets a value that indicates whether desktop composition is enabled.\r
+ </summary>\r
+ <value>\r
+ <see langword="true" /> when desktop composition is supported and enabled; otherwise, <see langword="false" />.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.CredentialDialog">\r
+ <summary>\r
+ Represents a dialog box that allows the user to enter generic credentials.\r
+ </summary>\r
+ <remarks>\r
+ <para>\r
+ This class is meant for generic credentials; it does not provide access to all the functionality\r
+ of the Windows CredUI API. Features such as Windows domain credentials or alternative security\r
+ providers (e.g. smartcards or biometric devices) are not supported.\r
+ </para>\r
+ <para>\r
+ The <see cref="T:Ookii.Dialogs.CredentialDialog"/> class provides methods for storing and retrieving credentials,\r
+ and also manages automatic persistence of credentials by using the "Save password" checkbox on\r
+ the credentials dialog. To specify the target for which the credentials should be saved, set the\r
+ <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/> property.\r
+ </para>\r
+ <note>\r
+ This class requires Windows XP or later.\r
+ </note>\r
+ </remarks>\r
+ <threadsafety instance="false" static="true"/>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.CredentialDialog.components">\r
+ <summary>\r
+ Required designer variable.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialDialog.Dispose(System.Boolean)">\r
+ <summary> \r
+ Clean up any resources being used.\r
+ </summary>\r
+ <param name="disposing"><see langword="true"/> if managed resources should be disposed; otherwise, <see langword="false"/>.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialDialog.InitializeComponent">\r
+ <summary>\r
+ Required method for Designer support - do not modify\r
+ the contents of this method with the code editor.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialDialog.#ctor">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialDialog"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialDialog.#ctor(System.ComponentModel.IContainer)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialDialog"/> class with the specified container.\r
+ </summary>\r
+ <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the component to.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialDialog.ShowDialog">\r
+ <summary>\r
+ Shows the credentials dialog as a modal dialog.\r
+ </summary>\r
+ <returns><see cref="F:System.Windows.Forms.DialogResult.OK"/> if the user clicked OK; otherwise, <see cref="F:System.Windows.Forms.DialogResult.Cancel"/>.</returns>\r
+ <remarks>\r
+ <para>\r
+ The credentials dialog will not be shown if one of the following conditions holds:\r
+ </para>\r
+ <list type="bullet">\r
+ <item>\r
+ <description>\r
+ <see cref="P:Ookii.Dialogs.CredentialDialog.UseApplicationInstanceCredentialCache"/> is <see langword="true"/> and the application instance\r
+ credential cache contains credentials for the specified <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/>, even if <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/>\r
+ is <see langword="true"/>.\r
+ </description>\r
+ </item>\r
+ <item>\r
+ <description>\r
+ <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\r
+ for the current user contains credentials for the specified <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/>.\r
+ </description>\r
+ </item>\r
+ </list>\r
+ <para>\r
+ 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\r
+ be set to the saved credentials and this function returns immediately, returning <see cref="F:System.Windows.Forms.DialogResult.OK"/>.\r
+ </para>\r
+ <para>\r
+ 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)"/>\r
+ after validating if the provided credentials are correct.\r
+ </para>\r
+ </remarks>\r
+ <exception cref="T:Ookii.Dialogs.CredentialException">An error occurred while showing the credentials dialog.</exception>\r
+ <exception cref="T:System.InvalidOperationException"><see cref="P:Ookii.Dialogs.CredentialDialog.Target"/> is an empty string ("").</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialDialog.ShowDialog(System.Windows.Forms.IWin32Window)">\r
+ <summary>\r
+ Shows the credentials dialog as a modal dialog with the specified owner.\r
+ </summary>\r
+ <param name="owner">The <see cref="T:System.Windows.Forms.IWin32Window"/> that owns the credentials dialog.</param>\r
+ <returns><see cref="F:System.Windows.Forms.DialogResult.OK"/> if the user clicked OK; otherwise, <see cref="F:System.Windows.Forms.DialogResult.Cancel"/>.</returns>\r
+ <remarks>\r
+ <para>\r
+ The credentials dialog will not be shown if one of the following conditions holds:\r
+ </para>\r
+ <list type="bullet">\r
+ <item>\r
+ <description>\r
+ <see cref="P:Ookii.Dialogs.CredentialDialog.UseApplicationInstanceCredentialCache"/> is <see langword="true"/> and the application instance\r
+ credential cache contains credentials for the specified <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/>, even if <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/>\r
+ is <see langword="true"/>.\r
+ </description>\r
+ </item>\r
+ <item>\r
+ <description>\r
+ <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\r
+ for the current user contains credentials for the specified <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/>.\r
+ </description>\r
+ </item>\r
+ </list>\r
+ <para>\r
+ 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\r
+ be set to the saved credentials and this function returns immediately, returning <see cref="F:System.Windows.Forms.DialogResult.OK"/>.\r
+ </para>\r
+ <para>\r
+ 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)"/>\r
+ after validating if the provided credentials are correct.\r
+ </para>\r
+ </remarks>\r
+ <exception cref="T:Ookii.Dialogs.CredentialException">An error occurred while showing the credentials dialog.</exception>\r
+ <exception cref="T:System.InvalidOperationException"><see cref="P:Ookii.Dialogs.CredentialDialog.Target"/> is an empty string ("").</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialDialog.ConfirmCredentials(System.Boolean)">\r
+ <summary>\r
+ Confirms the validity of the credential provided by the user.\r
+ </summary>\r
+ <param name="confirm"><see langword="true"/> if the credentials that were specified on the dialog are valid; otherwise, <see langword="false"/>.</param>\r
+ <remarks>\r
+ Call this function after calling <see cref="M:Ookii.Dialogs.CredentialDialog.ShowDialog"/> when <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> is <see langword="true"/>.\r
+ Only when this function is called with <paramref name="confirm"/> set to <see langword="true"/> will the credentials be\r
+ saved in the credentials store and/or the application instance credential cache.\r
+ </remarks>\r
+ <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"/>\r
+ at the call, or the value of <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/> or <see cref="P:Ookii.Dialogs.CredentialDialog.IsSaveChecked"/>\r
+ was changed after the call.</exception>\r
+ <exception cref="T:Ookii.Dialogs.CredentialException">There was an error saving the credentials.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialDialog.StoreCredential(System.String,System.Net.NetworkCredential)">\r
+ <summary>\r
+ Stores the specified credentials in the operating system's credential store for the currently logged on user.\r
+ </summary>\r
+ <param name="target">The target name for the credentials.</param>\r
+ <param name="credential">The credentials to store.</param>\r
+ <exception cref="T:System.ArgumentNullException">\r
+ <para>\r
+ <paramref name="target"/> is <see langword="null"/>.\r
+ </para>\r
+ <para>\r
+ -or-\r
+ </para>\r
+ <para>\r
+ <paramref name="credential"/> is <see langword="null"/>.\r
+ </para>\r
+ </exception>\r
+ <exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>\r
+ <exception cref="T:Ookii.Dialogs.CredentialException">An error occurred storing the credentials.</exception>\r
+ <remarks>\r
+ <note>\r
+ The <see cref="P:System.Net.NetworkCredential.Domain"/> property is ignored and will not be stored, even if it is\r
+ not <see langword="null"/>.\r
+ </note>\r
+ <para>\r
+ If the credential manager already contains credentials for the specified <paramref name="target"/>, they\r
+ will be overwritten; this can even overwrite credentials that were stored by another application. Therefore \r
+ it is strongly recommended that you prefix the target name to ensure uniqueness, e.g. using the\r
+ form "Company_ApplicationName_www.example.com".\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialDialog.RetrieveCredential(System.String)">\r
+ <summary>\r
+ Retrieves credentials for the specified target from the operating system's credential store for the current user.\r
+ </summary>\r
+ <param name="target">The target name for the credentials.</param>\r
+ <returns>The credentials if they were found; otherwise, <see langword="null"/>.</returns>\r
+ <remarks>\r
+ <para>\r
+ If the requested credential was not originally stored using the <see cref="T:Ookii.Dialogs.CredentialDialog"/> class (but e.g. by \r
+ another application), the password may not be decoded correctly.\r
+ </para>\r
+ <para>\r
+ This function does not check the application instance credential cache for the credentials; for that you can use\r
+ the <see cref="M:Ookii.Dialogs.CredentialDialog.RetrieveCredentialFromApplicationInstanceCache(System.String)"/> function.\r
+ </para>\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentNullException"><paramref name="target"/> is <see langword="null"/>.</exception>\r
+ <exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>\r
+ <exception cref="T:Ookii.Dialogs.CredentialException">An error occurred retrieving the credentials.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialDialog.RetrieveCredentialFromApplicationInstanceCache(System.String)">\r
+ <summary>\r
+ Tries to get the credentials for the specified target from the application instance credential cache.\r
+ </summary>\r
+ <param name="target">The target for the credentials, typically a server name.</param>\r
+ <returns>The credentials that were found in the application instance cache; otherwise, <see langword="null"/>.</returns>\r
+ <remarks>\r
+ <para>\r
+ This function will only check the the application instance credential cache; the operating system's credential store\r
+ is not checked. To retrieve credentials from the operating system's store, use <see cref="M:Ookii.Dialogs.CredentialDialog.RetrieveCredential(System.String)"/>.\r
+ </para>\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentNullException"><paramref name="target"/> is <see langword="null"/>.</exception>\r
+ <exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialDialog.DeleteCredential(System.String)">\r
+ <summary>\r
+ Deletes the credentials for the specified target.\r
+ </summary>\r
+ <param name="target">The name of the target for which to delete the credentials.</param>\r
+ <returns><see langword="true"/> if the credential was deleted from either the application instance cache or\r
+ the operating system's store; <see langword="false"/> if no credentials for the specified target could be found\r
+ in either store.</returns>\r
+ <remarks>\r
+ <para>\r
+ The credentials for the specified target will be removed from the application instance credential cache\r
+ and the operating system's credential store.\r
+ </para>\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentNullException"><paramref name="target"/> is <see langword="null"/>.</exception>\r
+ <exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>\r
+ <exception cref="T:Ookii.Dialogs.CredentialException">An error occurred deleting the credentials from the operating system's credential store.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialDialog.OnUserNameChanged(System.EventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.CredentialDialog.UserNameChanged"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.CredentialDialog.OnPasswordChanged(System.EventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.CredentialDialog.PasswordChanged"/> event.\r
+ </summary>\r
+ <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.CredentialDialog.UserNameChanged">\r
+ <summary>\r
+ Event raised when the <see cref="P:Ookii.Dialogs.CredentialDialog.UserName"/> property changes.\r
+ </summary>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.CredentialDialog.PasswordChanged">\r
+ <summary>\r
+ Event raised when the <see cref="P:Ookii.Dialogs.CredentialDialog.Password"/> property changes.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.CredentialDialog.UseApplicationInstanceCredentialCache">\r
+ <summary>\r
+ Gets or sets whether to use the application instance credential cache.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> when credentials are saved in the application instance cache; <see langref="false"/> if they are not.\r
+ The default value is <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ The application instance credential cache stores credentials in memory while an application is running. When the\r
+ application exits, this cache is not persisted.\r
+ </para>\r
+ <para>\r
+ When the <see cref="P:Ookii.Dialogs.CredentialDialog.UseApplicationInstanceCredentialCache"/> property is set to <see langword="true"/>, credentials that\r
+ are confirmed with <see cref="M:Ookii.Dialogs.CredentialDialog.ConfirmCredentials(System.Boolean)"/> when the user checked the "save password" option will be stored\r
+ in the application instance cache as well as the operating system credential store.\r
+ </para>\r
+ <para>\r
+ 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\r
+ the application instance cache, the dialog will not be shown and the cached credentials are returned, even if\r
+ <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/> is <see langword="true"/>.\r
+ </para>\r
+ <para>\r
+ The application instance credential cache allows you to prevent prompting the user again for the lifetime of the\r
+ application if the "save password" checkbox was checked, but when the application is restarted you can prompt again\r
+ (initializing the dialog with the saved credentials). To get this behaviour, the <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/>\r
+ property must be set to <see langword="true"/>.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.CredentialDialog.IsSaveChecked">\r
+ <summary>\r
+ Gets or sets whether the "save password" checkbox is checked.\r
+ </summary>\r
+ <value>\r
+ <see langword="true" /> if the "save password" is checked; otherwise, <see langword="false" />.\r
+ The default value is <see langword="false" />.\r
+ </value>\r
+ <remarks>\r
+ The value of this property is only valid if the dialog box is displayed with a save checkbox.\r
+ Set this property before showing the dialog to determine the initial checked value of the save checkbox.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.CredentialDialog.Password">\r
+ <summary>\r
+ Gets the password the user entered in the dialog.\r
+ </summary>\r
+ <value>\r
+ The password entered in the password field of the credentials dialog.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.CredentialDialog.Credentials">\r
+ <summary>\r
+ Gets the user-specified user name and password in a <see cref="T:System.Net.NetworkCredential"/> object.\r
+ </summary>\r
+ <value>\r
+ A <see cref="T:System.Net.NetworkCredential"/> instance containing the user name and password specified on the dialog.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.CredentialDialog.UserName">\r
+ <summary>\r
+ Gets the user name the user entered in the dialog.\r
+ </summary>\r
+ <value>\r
+ The user name entered in the user name field of the credentials dialog.\r
+ The default value is an empty string ("").\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.CredentialDialog.Target">\r
+ <summary>\r
+ Gets or sets the target for the credentials, typically a server name.\r
+ </summary>\r
+ <value>\r
+ The target for the credentials. The default value is an empty string ("").\r
+ </value>\r
+ <remarks>\r
+ Credentials are stored on a per user, not on a per application basis. To ensure that credentials stored by different \r
+ applications do not conflict, you should prefix the target with an application-specific identifer, e.g. \r
+ "Company_Application_target".\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.CredentialDialog.WindowTitle">\r
+ <summary>\r
+ Gets or sets the title of the credentials dialog.\r
+ </summary>\r
+ <value>\r
+ The title of the credentials dialog. The default value is an empty string ("").\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ This property is not used on Windows Vista and newer versions of windows; the window title will always be "Windows Security"\r
+ in that case.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.CredentialDialog.MainInstruction">\r
+ <summary>\r
+ Gets or sets a brief message to display in the dialog box.\r
+ </summary>\r
+ <value>\r
+ A brief message that will be displayed in the dialog box. The default value is an empty string ("").\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ On Windows Vista and newer versions of Windows, this text is displayed using a different style to set it apart\r
+ from the other text. In the default style, this text is a slightly larger and colored blue. The style is identical\r
+ to the main instruction of a task dialog.\r
+ </para>\r
+ <para>\r
+ 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"/>\r
+ property.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.CredentialDialog.Content">\r
+ <summary>\r
+ Gets or sets additional text to display in the dialog.\r
+ </summary>\r
+ <value>\r
+ Additional text to display in the dialog. The default value is an empty string ("").\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ On Windows Vista and newer versions of Windows, this text is placed below the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> text.\r
+ </para>\r
+ <para>\r
+ On Windows XP, how and if this text is displayed depends on the value of the <see cref="P:Ookii.Dialogs.CredentialDialog.DownlevelTextMode"/>\r
+ property.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.CredentialDialog.DownlevelTextMode">\r
+ <summary>\r
+ 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\r
+ is displayed on Windows XP.\r
+ </summary>\r
+ <value>\r
+ One of the values of the <see cref="T:Ookii.Dialogs.DownlevelTextMode"/> enumeration. The default value is\r
+ <see cref="F:Ookii.Dialogs.DownlevelTextMode.MainInstructionAndContent"/>.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ Windows XP does not support the distinct visual style of the main instruction, so there is no visual difference between the\r
+ text of the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/> properties. Depending\r
+ on your requirements, you may wish to hide either the main instruction or the content text.\r
+ </para>\r
+ <para>\r
+ This property has no effect on Windows Vista and newer versions of Windows.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox">\r
+ <summary>\r
+ 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\r
+ the credentials or not.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> when the "save password" checkbox is shown on the credentials dialog; otherwise, <see langword="false"/>.\r
+ The default value is <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ 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\r
+ credentials. When this property is set to <see langword="false"/>, the credentials will never be saved, and you should not call\r
+ the <see cref="M:Ookii.Dialogs.CredentialDialog.ConfirmCredentials(System.Boolean)"/> method.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials">\r
+ <summary>\r
+ Gets or sets a value that indicates whether the dialog should be displayed even when saved credentials exist for the \r
+ specified target.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the dialog is displayed even when saved credentials exist; otherwise, <see langword="false"/>.\r
+ The default value is <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ This property applies only when the <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> property is <see langword="true"/>.\r
+ </para>\r
+ <para>\r
+ Note that even if this property is <see langword="true"/>, if the proper credentials exist in the \r
+ application instance credentials cache the dialog will not be displayed.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.CredentialDialog.IsStoredCredential">\r
+ <summary>\r
+ Gets a value that indicates whether the current credentials were retrieved from a credential store.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the current credentials returned by the <see cref="P:Ookii.Dialogs.CredentialDialog.UserName"/>, <see cref="P:Ookii.Dialogs.CredentialDialog.Password"/>,\r
+ and <see cref="P:Ookii.Dialogs.CredentialDialog.Credentials"/> properties were retrieved from either the application instance credential cache\r
+ or the operating system's credential store; otherwise, <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ <para>\r
+ You can use this property to determine if the credentials dialog was shown after a call to <see cref="M:Ookii.Dialogs.CredentialDialog.ShowDialog"/>.\r
+ If the dialog was shown, this property will be <see langword="false"/>; if the credentials were retrieved from the\r
+ application instance cache or the credential store and the dialog was not shown it will be <see langword="true"/>.\r
+ </para>\r
+ <para>\r
+ If the <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/> property is set to <see langword="true"/>, and the dialog is shown\r
+ but populated with stored credentials, this property will still return <see langword="false"/>.\r
+ </para>\r
+ </remarks>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.VistaSaveFileDialog">\r
+ <summary>\r
+ Prompts the user to select a location for saving a file.\r
+ </summary>\r
+ <remarks>\r
+ <para>\r
+ This class will use the Vista style file dialog if possible, and automatically fall back to the old-style \r
+ dialog on versions of Windows older than Vista.\r
+ </para>\r
+ <para>\r
+ As of .Net 3.5 and .Net 2.0 SP1, the regular <see cref="T:System.Windows.Forms.FileDialog"/> class will also use\r
+ the new Vista style dialogs. However, certain options, such as settings <see cref="P:System.Windows.Forms.OpenFileDialog.ShowReadOnly"/>,\r
+ still cause that class to revert to the old style dialogs. For this reason, this class is still provided.\r
+ It is recommended that you use the <see cref="T:System.Windows.Forms.SaveFileDialog"/> class whenever possible.\r
+ </para>\r
+ </remarks>\r
+ <threadsafety static="true" instance="false"/>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaSaveFileDialog.#ctor">\r
+ <summary>\r
+ Creates a new instance of <see cref="T:Ookii.Dialogs.VistaSaveFileDialog"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaSaveFileDialog.#ctor(System.Boolean)">\r
+ <summary>\r
+ Creates a new instance of <see cref="T:Ookii.Dialogs.VistaSaveFileDialog"/> class.\r
+ </summary>\r
+ <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>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaSaveFileDialog.Reset">\r
+ <summary>\r
+ Resets all properties to their default values.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaSaveFileDialog.OpenFile">\r
+ <summary>\r
+ Opens the file with read/write permission selected by the user.\r
+ </summary>\r
+ <returns>The read/write file selected by the user.</returns>\r
+ <exception cref="T:System.ArgumentNullException"><see cref="P:Ookii.Dialogs.VistaFileDialog.FileName"/> is <see langword="null"/> or an empty string.</exception>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaSaveFileDialog.OnFileOk(System.ComponentModel.CancelEventArgs)">\r
+ <summary>\r
+ Raises the <see cref="E:Ookii.Dialogs.VistaFileDialog.FileOk"/> event.\r
+ </summary>\r
+ <param name="e">A <see cref="T:System.ComponentModel.CancelEventArgs"/> that contains the event data.</param> \r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaSaveFileDialog.CreatePrompt">\r
+ <summary>\r
+ Gets or sets a value indicating whether the dialog box prompts the user for permission to create a file if the \r
+ user specifies a file that does not exist.\r
+ </summary>\r
+ <value>\r
+ <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; \r
+ <see langword="false"/> if the dialog box automatically creates the new file without prompting the user for permission. The default \r
+ value is <see langword="false"/>.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaSaveFileDialog.OverwritePrompt">\r
+ <summary>\r
+ Gets or sets a value indicating whether the Save As dialog box displays a warning if the user \r
+ specifies a file name that already exists.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the dialog box prompts the user before overwriting an existing file if the user specifies a file \r
+ name that already exists; <see langword="false"/> if the dialog box automatically overwrites the existing file without \r
+ prompting the user for permission. The default value is <see langword="true"/>.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.ButtonType">\r
+ <summary>\r
+ Represents the type of a task dialog button.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ButtonType.Custom">\r
+ <summary>\r
+ The button is a custom button.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ButtonType.Ok">\r
+ <summary>\r
+ The button is the common OK button.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ButtonType.Yes">\r
+ <summary>\r
+ The button is the common Yes button.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ButtonType.No">\r
+ <summary>\r
+ The button is the common No button.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ButtonType.Cancel">\r
+ <summary>\r
+ The button is the common Cancel button.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ButtonType.Retry">\r
+ <summary>\r
+ The button is the common Retry button.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.ButtonType.Close">\r
+ <summary>\r
+ The button is the common Close button.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.VistaFolderBrowserDialog">\r
+ <summary>\r
+ Prompts the user to select a folder.\r
+ </summary>\r
+ <remarks>\r
+ This class will use the Vista style Select Folder dialog if possible, or the regular FolderBrowserDialog\r
+ if it is not. Note that the Vista style dialog is very different, so using this class without testing\r
+ in both Vista and older Windows versions is not recommended.\r
+ </remarks>\r
+ <threadsafety instance="false" static="true" />\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaFolderBrowserDialog.#ctor">\r
+ <summary>\r
+ Creates a new instance of the <see cref="T:Ookii.Dialogs.VistaFolderBrowserDialog"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaFolderBrowserDialog.Reset">\r
+ <summary>\r
+ Resets all properties to their default values.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaFolderBrowserDialog.RunDialog(System.IntPtr)">\r
+ <summary>\r
+ Specifies a common dialog box.\r
+ </summary>\r
+ <param name="hwndOwner">A value that represents the window handle of the owner window for the common dialog box.</param>\r
+ <returns><see langword="true" /> if the file could be opened; otherwise, <see langword="false" />.</returns>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.VistaFolderBrowserDialog.Dispose(System.Boolean)">\r
+ <summary>\r
+ Releases the unmanaged resources used by the <see cref="T:Ookii.Dialogs.VistaFolderBrowserDialog"/> and optionally releases the managed resources.\r
+ </summary>\r
+ <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>\r
+ </member>\r
+ <member name="E:Ookii.Dialogs.VistaFolderBrowserDialog.HelpRequest">\r
+ <summary>\r
+ Occurs when the user clicks the Help button on the dialog box.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.IsVistaFolderDialogSupported">\r
+ <summary>\r
+ Gets a value that indicates whether the current OS supports Vista-style common file dialogs.\r
+ </summary>\r
+ <value>\r
+ <see langword="true" /> on Windows Vista or newer operating systems; otherwise, <see langword="false" />.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.Description">\r
+ <summary>\r
+ Gets or sets the descriptive text displayed above the tree view control in the dialog box, or below the list view control\r
+ in the Vista style dialog.\r
+ </summary>\r
+ <value>\r
+ The description to display. The default is an empty string ("").\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.RootFolder">\r
+ <summary>\r
+ Gets or sets the root folder where the browsing starts from. This property has no effect if the Vista style\r
+ dialog is used.\r
+ </summary>\r
+ <value>\r
+ One of the <see cref="T:System.Environment.SpecialFolder"/> values. The default is Desktop.\r
+ </value>\r
+ <exception cref="T:System.ComponentModel.InvalidEnumArgumentException">The value assigned is not one of the <see cref="T:System.Environment.SpecialFolder"/> values.</exception>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.SelectedPath">\r
+ <summary>\r
+ Gets or sets the path selected by the user.\r
+ </summary>\r
+ <value>\r
+ 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 ("").\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.ShowNewFolderButton">\r
+ <summary>\r
+ Gets or sets a value indicating whether the New Folder button appears in the folder browser dialog box. This\r
+ property has no effect if the Vista style dialog is used; in that case, the New Folder button is always shown.\r
+ </summary>\r
+ <value>\r
+ <see langword="true" /> if the New Folder button is shown in the dialog box; otherwise, <see langword="false" />. The default is <see langword="true" />.\r
+ </value>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.UseDescriptionForTitle">\r
+ <summary>\r
+ Gets or sets a value that indicates whether to use the value of the <see cref="P:Ookii.Dialogs.VistaFolderBrowserDialog.Description"/> property\r
+ as the dialog title for Vista style dialogs. This property has no effect on old style dialogs.\r
+ </summary>\r
+ <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"/>\r
+ to indicate the value is added as additional text to the dialog. The default is <see langword="false"/>.</value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.TaskDialogButtonStyle">\r
+ <summary>\r
+ Indicates the display style of custom buttons on a task dialog.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.TaskDialogButtonStyle.Standard">\r
+ <summary>\r
+ Custom buttons are displayed as regular buttons.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinks">\r
+ <summary>\r
+ Custom buttons are displayed as command links using a standard task dialog glyph.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinksNoIcon">\r
+ <summary>\r
+ Custom buttons are displayed as command links without a glyph.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.TaskDialogRadioButton">\r
+ <summary>\r
+ A radio button on a task dialog.\r
+ </summary>\r
+ <threadsafety static="true" instance="false" />\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogRadioButton.#ctor">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogRadioButton"/> class.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.TaskDialogRadioButton.#ctor(System.ComponentModel.IContainer)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogRadioButton"/> class with the specified container.\r
+ </summary>\r
+ <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.TaskDialogRadioButton"/> to.</param>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialogRadioButton.Checked">\r
+ <summary>\r
+ Gets or sets a value that indicates whether the radio button is checked.\r
+ </summary>\r
+ <value>\r
+ <see langword="true"/> if the radio button is checked; otherwise, <see langword="false"/>.\r
+ The default value is <see langword="false"/>.\r
+ </value>\r
+ <remarks>\r
+ Setting this property while the dialog is being displayed has no effect. Instead, use the <see cref="M:Ookii.Dialogs.TaskDialogItem.Click"/>\r
+ method to check a particular radio button.\r
+ </remarks>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.TaskDialogRadioButton.ItemCollection">\r
+ <summary>\r
+ Gets the collection that items of this type are part of.\r
+ </summary>\r
+ <value>\r
+ If the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> is currently associated with a <see cref="T:Ookii.Dialogs.TaskDialog"/>, the\r
+ <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/> collection of that <see cref="T:Ookii.Dialogs.TaskDialog"/>; otherwise, <see langword="null"/>.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.HyperlinkClickedEventArgs">\r
+ <summary>\r
+ Class that provides data for the <see cref="E:Ookii.Dialogs.TaskDialog.HyperlinkClicked"/> event.\r
+ </summary>\r
+ <threadsafety instance="false" static="true"/>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.HyperlinkClickedEventArgs.#ctor(System.String)">\r
+ <summary>\r
+ Creates a new instance of the <see cref="T:Ookii.Dialogs.HyperlinkClickedEventArgs"/> class with the specified URL.\r
+ </summary>\r
+ <param name="href">The URL of the hyperlink.</param>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.HyperlinkClickedEventArgs.Href">\r
+ <summary>\r
+ Gets the URL of the hyperlink that was clicked.\r
+ </summary>\r
+ <value>\r
+ The value of the href attribute of the hyperlink.\r
+ </value>\r
+ </member>\r
+ <member name="T:Ookii.Dialogs.ExpandButtonClickedEventArgs">\r
+ <summary>\r
+ Provides data for the <see cref="E:Ookii.Dialogs.TaskDialog.ExpandButtonClicked"/> event.\r
+ </summary>\r
+ <threadsafety instance="false" static="true"/>\r
+ </member>\r
+ <member name="M:Ookii.Dialogs.ExpandButtonClickedEventArgs.#ctor(System.Boolean)">\r
+ <summary>\r
+ Initializes a new instance of the <see cref="T:Ookii.Dialogs.ExpandButtonClickedEventArgs"/> class with the specified expanded state.\r
+ </summary>\r
+ <param name="expanded"><see langword="true"/> if the the expanded content on the dialog is shown; otherwise, <see langword="false"/>.</param>\r
+ </member>\r
+ <member name="P:Ookii.Dialogs.ExpandButtonClickedEventArgs.Expanded">\r
+ <summary>\r
+ Gets a value that indicates if the expanded content on the dialog is shown.\r
+ </summary>\r
+ <value><see langword="true" /> if the expanded content on the dialog is shown; otherwise, <see langword="false" />.</value>\r
+ </member>\r
+ </members>\r
+</doc>\r
projects / handbrake / commitdiff