Ookii.Dialogs.Wpf

Represents a list of objects.

The type of the task dialog item.

Overrides the method.

Overrides the method.

The zero-based index at which should be inserted. The object to insert. May not be . is . The specified in is already associated with a different task dialog. The specified in has a duplicate id or button type. is less than zero. -or- is equal to or greater than .

Overrides the method.

The zero-based index of the element to remove. is less than zero. -or- is equal to or greater than .

Overrides the method.

The zero-based index of the element to replace. The new value for the element at the specified index. May not be . is . The specified in is already associated with a different task dialog. The specified in has a duplicate id or button type. is less than zero. -or- is equal to or greater than .

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Looks up a localized string similar to Unable to load the progress dialog animation: {0}.

Looks up a localized string similar to The credential target may not be an empty string..

Looks up a localized string similar to An error occurred acquiring credentials..

Looks up a localized string similar to PromptForCredentialsWithSave has not been called or the credentials were modified after the call..

Looks up a localized string similar to The task dialog already has a non-custom button with the same type..

Looks up a localized string similar to The task dialog already has an item with the same id..

Looks up a localized string similar to The file "{0}" could not be found..

Looks up a localized string similar to Unable to retrieve the root folder..

Looks up a localized string similar to The current operating system does not support glass, or the Desktop Window Manager is not enabled..

Looks up a localized string similar to Invalid filter string,.

Looks up a localized string similar to The id of a task dialog item must be higher than 0..

Looks up a localized string similar to The item is not associated with a task dialog..

Looks up a localized string similar to Cannot change the id for a standard button..

Looks up a localized string similar to Preview.

Looks up a localized string similar to The progress dialog is not shown..

Looks up a localized string similar to The progress dialog is already running..

Looks up a localized string similar to A custom button or radio button cannot have an empty label..

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..

Looks up a localized string similar to The task dialog item already belongs to another task dialog..

Looks up a localized string similar to The task dialog must have buttons..

Looks up a localized string similar to The task dialog is not current displayed..

Looks up a localized string similar to The task dialog is already being displayed..

Looks up a localized string similar to The operating system does not support task dialogs..

C# definition of the IMalloc interface.

Allocate a block of memory

Size, in bytes, of the memory block to be allocated. a pointer to the allocated memory block.

Changes the size of a previously allocated memory block.

Pointer to the memory block to be reallocated Size of the memory block, in bytes, to be reallocated. reallocated memory block

Free a previously allocated block of memory.

Pointer to the memory block to be freed.

This method returns the size, in bytes, of a memory block previously allocated with IMalloc::Alloc or IMalloc::Realloc.

Pointer to the memory block for which the size is requested The size of the allocated memory block in bytes.

This method determines whether this allocator was used to allocate the specified block of memory.

Pointer to the memory block 1 - allocated 0 - not allocated by this IMalloc Instance. -1 if DidAlloc is unable to determine whether or not it allocated the memory block.

Minimizes the heap by releasing unused memory to the operating system.

Indicates the type of progress on a task dialog.

No progress bar is displayed on the dialog.

A regular progress bar is displayed on the dialog.

A marquee progress bar is displayed on the dialog. Use this value for operations that cannot report concrete progress information.

The exception that is thrown when an error occurs getting credentials.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified error.

The Win32 error code associated with this exception.

Initializes a new instance of the class with a specified error message.

The message that describes the error.

Initializes a new instance of the class with the specified error and the specified detailed description.

The Win32 error code associated with this exception. A detailed description of the error.

Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception.

The error message that explains the reason for the exception. A reference to the inner exception that is the cause of the current exception.

Initializes a new instance of the class with serialized data.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination.

Prompts the user to open a file.

Windows Vista provides a new style of common file dialog, with several new features (both from the user's and the programmers perspective). This class will use the Vista-style file dialogs if possible, and automatically fall back to the old-style dialog on versions of Windows older than Vista. This class is aimed at applications that target both Windows Vista and older versions of Windows, and therefore does not provide any of the new APIs provided by Vista's file dialogs. This class precisely duplicates the public interface of so you can just replace any instances of with the without any further changes to your code.

Displays a dialog box from which the user can select a file.

Windows Vista provides a new style of common file dialog, with several new features (both from the user's and the programmers perspective). This class and derived classes will use the Vista-style file dialogs if possible, and automatically fall back to the old-style dialog on versions of Windows older than Vista. This class is aimed at applications that target both Windows Vista and older versions of Windows, and therefore does not provide any of the new APIs provided by Vista's file dialogs. This class precisely duplicates the public interface of so you can just replace any instances of with the without any further changes to your code.

Creates a new instance of class.

Resets all properties to their default values.

Displays the file dialog.

If the user clicks the OK button of the dialog that is displayed (e.g. , ), is returned; otherwise, .

Displays the file dialog.

Handle to the window that owns the dialog. If the user clicks the OK button of the dialog that is displayed (e.g. , ), is returned; otherwise, .

Raises the event.

A that contains the event data.

Event raised when the user clicks on the Open or Save button on a file dialog box.

Gets a value that indicates whether the current OS supports Vista-style common file dialogs.

if Vista-style common file dialgs are supported; otherwise, . Returns on Windows Vista or newer operating systems. If this property returns , the class (and its derived classes) will fall back to the regular file dialog.

Gets or sets a value indicating whether the dialog box automatically adds an extension to a file name if the user omits the extension.

if the dialog box adds an extension to a file name if the user omits the extension; otherwise, . The default value is .

Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.

if the dialog box displays a warning if the user specifies a file name that does not exist; otherwise, . The default value is .

Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a path that does not exist.

if the dialog box displays a warning when the user specifies a path that does not exist; otherwise, . The default value is .

Gets or sets the default file name extension.

The default file name extension. The returned string does not include the period. The default value is an empty string ("").

Gets or sets a value indicating whether the dialog box returns the location of the file referenced by the shortcut or whether it returns the location of the shortcut (.lnk).

if the dialog box returns the location of the file referenced by the shortcut; otherwise, . The default value is .

Gets or sets a string containing the file name selected in the file dialog box.

The file name selected in the file dialog box. The default value is an empty string ("").

Gets the file names of all selected files in the dialog box.

An array of type , containing the file names of all selected files in the dialog box.

Gets or sets the current file name filter string, which determines the choices that appear in the "Save as file type" or "Files of type" box in the dialog box.

The file filtering options available in the dialog box. Filter format is invalid.

Gets or sets the index of the filter currently selected in the file dialog box.

A value containing the index of the filter currently selected in the file dialog box. The default value is 1.

Gets or sets the initial directory displayed by the file dialog box.

The initial directory displayed by the file dialog box. The default is an empty string ("").

Gets or sets a value indicating whether the dialog box restores the current directory before closing.

if the dialog box restores the current directory to its original value if the user changed the directory while searching for files; otherwise, . The default value is .

Gets or sets the file dialog box title.

The file dialog box title. The default value is an empty string ("").

Gets or sets a value indicating whether the dialog box accepts only valid Win32 file names.

if the dialog box accepts only valid Win32 file names; otherwise, . The default value is .

Gets or sets the downlevel file dialog which is to be used if the Vista-style dialog is not supported.

The regular that is used when the Vista-style file dialog is not supported. This property is set by classes that derive from .

Creates a new instance of class.

Resets all properties to their default values.

Opens the file selected by the user, with read-only permission. The file is specified by the FileName property.

A Stream that specifies the read-only file selected by the user. The file name is .

Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.

if the dialog box displays a warning if the user specifies a file name that does not exist; otherwise, . The default value is .

Gets or sets a value indicating whether the dialog box allows multiple files to be selected.

if the dialog box allows multiple files to be selected together or concurrently; otherwise, . The default value is .

Gets or sets a value indicating whether the dialog box contains a read-only check box.

if the dialog box contains a read-only check box; otherwise, . The default value is . If the Vista style dialog is used, this property can only be used to determine whether the user chose Open as read-only on the dialog; setting it in code will have no effect.

Gets or sets a value indicating whether the read-only check box is selected.

if the read-only check box is selected; otherwise, . The default value is .

A button on a .

Represents a button or radio button on a task dialog.

Required designer variable.

Clean up any resources being used.

if managed resources should be disposed; otherwise, .

Required method for Designer support - do not modify the contents of this method with the code editor.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified container.

The to add the to.

Simulates a click on the task dialog item.

This method is available only while the task dialog is being displayed. You would typically call it from one of the events fired by the class while the dialog is visible. The task dialog is not being displayed -or- The item has no associated task dialog.

Causes a full update of the owner dialog.

When this method is called, the owner dialog will be updated to reflect the current state of the object. When the has no owner, or the owner is not being displayed, this method has no effect.

Gets the that owns this .

The that owns this . This property is set automatically when the is added to the or collection of a .

Gets or sets the text of the item.

The text of the item. The default value is an empty string (""). For buttons, this property is ignored if is any value other than .

Gets or sets a value that indicates whether the item is enabled.

if this item is enabled; otherwise, . If a button or radio button is not enabled, it will be grayed out and cannot be selected or clicked.

Gets or sets the ID of the item.

The unique identifier of the item. The identifier of an item must be unique for the type of item on the task dialog (i.e. no two buttons can have the same id, no two radio buttons can have the same id, but a radio button can have the same id as a button). If this property is zero when the is added to the or collection of a task dialog, it will automatically be set to the next available id value.

When implemented in a derived class, gets the item collection on a task dialog that this type of item is part of.

For items, the collection of the instance this item is part of. For items, the collection of the instance this item is part of. If the is not currently associated with a , . The collection returned by this property is used to determine if there are any items with duplicate IDs.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified button type.

The type of the button.

Initializes a new instance of the class with the specified container.

The to add the to.

Initializes a new instance of the class with the specified text.

The text of the button.

Gets or sets the type of the button.

One of the values that indicates the type of the button. The default value is .

Gets or sets the text of the note associated with a command link button.

The text of the note associated with a command link button. This property applies only to buttons where the property is . For other button types, it is ignored. In addition, it is used only if the property is set to or ; otherwise, it is ignored.

Gets or sets a value that indicates if the button is the default button on the dialog.

if the button is the default button; otherwise, . The default value is . If no button has this property set to , the first button on the dialog will be the default button.

Gets or sets a value that indicates whether the Task Dialog button or command link should have a User Account Control (UAC) shield icon (in other words, whether the action invoked by the button requires elevation).

if the button contains a UAC shield icon; otherwise, . Elevation is not performed by the task dialog; the code implementing the operation that results from the button being clicked is responsible for performing elevation if required.

Gets the collection that items of this type are part of.

If the is currently associated with a , the collection of that ; otherwise, .

Displays a Task Dialog.

The task dialog contains an application-defined message text and title, icons, and any combination of predefined push buttons. Task Dialogs are supported only on Windows Vista and above. No fallback is provided; if you wish to use task dialogs and support operating systems older than Windows Vista, you must provide a fallback yourself. Check the property to see if task dialogs are supported. It is safe to instantiate the class on an older OS, but calling or will throw an exception.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified container.

The to add the to.

Shows the task dialog as a modeless dialog.

The button that the user clicked. Can be if the user cancelled the dialog using the title bar close button. Although the dialog is modeless, this method does not return until the task dialog is closed. One of the properties or a combination of properties is not valid. -or- The dialog is already running. Task dialogs are not supported on the current operating system.

Shows the task dialog as a modal dialog.

The button that the user clicked. Can be if the user cancelled the dialog using the title bar close button. The dialog will use the active window as its owner. If the current process has no active window, the dialog will be displayed as a modeless dialog (identical to calling ). One of the properties or a combination of properties is not valid. -or- The dialog is already running. Task dialogs are not supported on the current operating system.

Shows the task dialog as a modal dialog.

The that is the owner of this task dialog. The button that the user clicked. Can be if the user cancelled the dialog using the title bar close button. One of the properties or a combination of properties is not valid. -or- The dialog is already running. Task dialogs are not supported on the current operating system.

Simulates a click on the verification checkbox of the , if it exists.

to set the state of the checkbox to be checked; to set it to be unchecked. to set the keyboard focus to the checkbox; otherwise . The task dialog is not being displayed.

Raises the event.

The containing the data for the event.

Raises the event.

The containing the data for the event.

Raises the event.

The containing the data for the event.

Raises the event.

The containing the data for the event.

Raises the event.

The containing the data for the event.

Raises the event.

The containing the data for the event.

Raises the event.

The containing the data for the event.

Raises the event.

The containing the data for the event.

Raises the event.

The containing the data for the event.

Required designer variable.

Clean up any resources being used.

if managed resources should be disposed; otherwise, .

Required method for Designer support - do not modify the contents of this method with the code editor.

Event raised when the task dialog has been created.

This event is raised once after calling , after the dialog is created and before it is displayed.

Event raised when the task dialog has been destroyed.

The task dialog window no longer exists when this event is raised.

Event raised when the user clicks a button on the task dialog.

Set the property to to prevent the dialog from being closed.

Event raised when the user clicks a radio button on the task dialog.

The property is ignored for this event.

Event raised when the user clicks a hyperlink.

Event raised when the user clicks the verification check box.

Event raised periodically while the dialog is displayed.

This event is raised only when the property is set to . The event is raised approximately every 200 milliseconds. To reset the tick count, set the property to .

Event raised when the user clicks the expand button on the task dialog.

The property indicates if the expanded information is visible or not after the click.

Event raised when the user presses F1 while the dialog has focus.

Gets a value that indicates whether the current operating system supports task dialogs.

Returns for Windows Vista or later; otherwise .

Gets a list of the buttons on the Task Dialog.

A list of the buttons on the Task Dialog. Custom buttons are displayed in the order they have in the collection. Standard buttons will always be displayed in the Windows-defined order, regardless of the order of the buttons in the collection.

Gets a list of the radio buttons on the Task Dialog.

A list of the radio buttons on the Task Dialog.

Gets or sets the window title of the task dialog.

The window title of the task dialog. The default is an empty string ("").

Gets or sets the dialog's main instruction.

The dialog's main instruction. The default is an empty string (""). The main instruction of a task dialog will be displayed in a larger font and a different color than the other text of the task dialog.

Gets or sets the dialog's primary content.

The dialog's primary content. The default is an empty string ("").

Gets or sets the icon to be used in the title bar of the dialog.

An that represents the icon of the task dialog's window. This property is used only when the dialog is shown as a modeless dialog; if the dialog is modal, it will have no icon.

Gets or sets the icon to display in the task dialog.

A that indicates the icon to display in the main content area of the task dialog. The default is . When this property is set to , use the property to specify the icon to use.

Gets or sets a custom icon to display in the dialog.

An that represents the icon to display in the main content area of the task dialog, or if no custom icon is used. The default value is . This property is ignored if the property has a value other than .

Gets or sets the icon to display in the footer area of the task dialog.

A that indicates the icon to display in the footer area of the task dialog. The default is . When this property is set to , use the property to specify the icon to use. The footer icon is displayed only if the property is not an empty string ("").

Gets or sets a custom icon to display in the footer area of the task dialog.

An that represents the icon to display in the footer area of the task dialog, or if no custom icon is used. The default value is . This property is ignored if the property has a value other than . The footer icon is displayed only if the property is not an empty string ("").

Gets or sets a value that indicates whether custom buttons should be displayed as normal buttons or command links.

A that indicates the display style of custom buttons on the dialog. The default value is . This property affects only custom buttons, not standard ones. If a custom button is being displayed on a task dialog with set to or , you delineate the command from the note by placing a line break in the string specified by property.

Gets or sets the label for the verification checkbox.

The label for the verification checkbox, or an empty string ("") if no verification checkbox is shown. The default value is an empty string (""). If no text is set, the verification checkbox will not be shown.

Gets or sets a value that indicates whether the verification checkbox is checked ot not.

if the verficiation checkbox is checked; otherwise, . Set this property before displaying the dialog to determine the initial state of the check box. Use this property after displaying the dialog to determine whether the check box was checked when the user closed the dialog. This property is only used if is not an empty string ("").

Gets or sets additional information to be displayed on the dialog.

Additional information to be displayed on the dialog. The default value is an empty string (""). When this property is not an empty string (""), a control is shown on the task dialog that allows the user to expand and collapse the text specified in this property. The text is collapsed by default unless is set to . The expanded text is shown in the main content area of the dialog, unless is set to , in which case it is shown in the footer area.

Gets or sets the text to use for the control for collapsing the expandable information specified in .

The text to use for the control for collapsing the expandable information, or an empty string ("") if the operating system's default text is to be used. The default is an empty string ("") If this text is not specified and is specified, the value of will be used for this property as well. If neither is specified, the operating system's default text is used. The control for collapsing or expanding the expandable information is displayed only if is not an empty string ("")

Gets or sets the text to use for the control for expading the expandable information specified in .

The text to use for the control for expanding the expandable information, or an empty string ("") if the operating system's default text is to be used. The default is an empty string ("") If this text is not specified and is specified, the value of will be used for this property as well. If neither is specified, the operating system's default text is used. The control for collapsing or expanding the expandable information is displayed only if is not an empty string ("")

Gets or sets the text to be used in the footer area of the task dialog.

The text to be used in the footer area of the task dialog, or an empty string ("") if the footer area is not displayed. The default value is an empty string ("").

Specifies the width of the task dialog's client area in DLU's.

The width of the task dialog's client area in DLU's, or 0 to have the task dialog calculate the ideal width. The default value is 0.

Gets or sets a value that indicates whether hyperlinks are allowed for the , and properties.

when hyperlinks are allowed for the , and properties; otherwise, . The default value is . When this property is , the , and properties can use hyperlinks in the following form: <A HREF="executablestring">Hyperlink Text</A> Enabling hyperlinks when using content from an unsafe source may cause security vulnerabilities. Task dialogs will not actually execute hyperlinks. To take action when the user presses a hyperlink, handle the event.

Gets or sets a value that indicates that the dialog should be able to be closed using Alt-F4, Escape and the title bar's close button even if no cancel button is specified.

if the dialog can be closed using Alt-F4, Escape and the title bar's close button even if no cancel button is specified; otherwise, . The default value is .

Gets or sets a value that indicates that the string specified by the property should be displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content.

if the string specified by the property should be displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content; otherwise, . The default value is .

Gets or sets a value that indicates that the string specified by the property should be displayed by default.

if the string specified by the property should be displayed by default; if it is hidden by default. The default value is .

Gets or sets a value that indicates whether the event is raised periodically while the dialog is visible.

when the event is raised periodically while the dialog is visible; otherwise, . The default value is . The event will be raised approximately every 200 milliseconds if this property is .

Gets or sets a value that indicates whether the dialog is centered in the parent window instead of the screen.

when the dialog is centered relative to the parent window; when it is centered on the screen. The default value is .

Gets or sets a value that indicates whether text is displayed right to left.

when the content of the dialog is displayed right to left; otherwise, . The default value is .

Gets or sets a value that indicates whether the dialog has a minimize box on its caption bar.

if the dialog has a minimize box on its caption bar when modeless; otherwise, . The default is . A task dialog can only have a minimize box if it is displayed as a modeless dialog. The minimize box will never appear when using the designer "Preview" option, since that displays the dialog modally.

Gets or sets the type of progress bar displayed on the dialog.

A that indicates the type of progress bar shown on the task dialog. If this property is set to , the marquee will scroll as long as the dialog is visible. If this property is set to , the value of the property must be updated to advance the progress bar. This can be done e.g. by an asynchronous operation or from the event. Updating the value of the progress bar using the while the dialog is visible property may only be done from the thread on which the task dialog was created.

Gets or sets the marquee animation speed of the progress bar in milliseconds.

The marquee animation speed of the progress bar in milliseconds. The default value is 100. This property is only used if the property is .

Gets or sets the lower bound of the range of the task dialog's progress bar.

The lower bound of the range of the task dialog's progress bar. The default value is 0. This property is only used if the property is . The new property value is not smaller than .

Gets or sets the upper bound of the range of the task dialog's progress bar.

The upper bound of the range of the task dialog's progress bar. The default value is 100. This property is only used if the property is . The new property value is not larger than .

Gets or sets the current value of the task dialog's progress bar.

The current value of the task dialog's progress bar. The default value is 0. This property is only used if the property is . Updating the value of the progress bar while the dialog is visible may only be done from the thread on which the task dialog was created. The new property value is smaller than or larger than .

Gets or sets the state of the task dialog's progress bar.

A indicating the state of the task dialog's progress bar. The default value is . This property is only used if the property is .

Gets or sets an object that contains data about the dialog.

An object that contains data about the dialog. The default value is . Use this property to store arbitrary information about the dialog.

Gets the window handle of the task dialog.

The window handle of the task dialog when it is being displayed, or when the dialog is not being displayed.

Indicates the display style of custom buttons on a task dialog.

Custom buttons are displayed as regular buttons.

Custom buttons are displayed as command links using a standard task dialog glyph.

Custom buttons are displayed as command links without a glyph.

Resource identifiers for default animations from shell32.dll.

An animation representing a file move.

An animation representing a file copy.

An animation showing flying papers.

An animation showing a magnifying glass over a globe.

An animation representing a permament delete.

An animation representing deleting an item from the recycle bin.

An animation representing a file move to the recycle bin.

An animation representing a search spanning the local computer.

An animation representing a search in a document..

An animation representing a search using a flashlight animation.

Prompts the user to select a location for saving a file.

This class will use the Vista style save file dialog if possible, and automatically fall back to the old-style dialog on versions of Windows older than Vista. Windows Vista provides a new style of common file dialog, with several new features (both from the user's and the programmers perspective). This class will use the Vista-style file dialogs if possible, and automatically fall back to the old-style dialog on versions of Windows older than Vista. This class is aimed at applications that target both Windows Vista and older versions of Windows, and therefore does not provide any of the new APIs provided by Vista's file dialogs. This class precisely duplicates the public interface of so you can just replace any instances of with the without any further changes to your code.

Creates a new instance of class.

Resets all properties to their default values.

Opens the file with read/write permission selected by the user.

The read/write file selected by the user. The file name is .

Raises the event.

A that contains the event data.

Gets or sets a value indicating whether the dialog box prompts the user for permission to create a file if the user specifies a file that does not exist.

if the dialog box prompts the user before creating a file if the user specifies a file name that does not exist; if the dialog box automatically creates the new file without prompting the user for permission. The default value is .

Gets or sets a value indicating whether the Save As dialog box displays a warning if the user specifies a file name that already exists.

if the dialog box prompts the user before overwriting an existing file if the user specifies a file name that already exists; if the dialog box automatically overwrites the existing file without prompting the user for permission. The default value is .

An enumeration that displays how the text in the and properties is displayed on a credential dialog in Windows XP.

Windows XP does not support the distinct visual style of the main instruction, so there is no visual difference between the text of the and properties. Depending on the scenario, you may wish to hide either the main instruction or the content text.

The text of the and properties is concatenated together, separated by an empty line.

Only the text of the property is shown.

Only the text of the property is shown.

Represents an animation for the loaded from a Win32 resource.

Initializes a new instance of the class.

The file containing the animation resource. The resource ID of the animation resource. is .

Gets a default animation from shell32.dll.

The animation to get. An instance of the class representing the specified animation. The parameter was not a value defined in the enumeration.

Gets the name of the file containing the animation resource.

The name of the file containing the animation resource. This is typically a DLL or EXE file.

Gets the ID of the animation resource.

The ID of the animation resource.

Prompts the user to select a folder.

This class will use the Vista style Select Folder dialog if possible, or the regular FolderBrowserDialog if it is not. Note that the Vista style dialog is very different, so using this class without testing in both Vista and older Windows versions is not recommended.

Creates a new instance of the class.

Resets all properties to their default values.

Displays the folder browser dialog.

If the user clicks the OK button, is returned; otherwise, .

Displays the folder browser dialog.

Handle to the window that owns the dialog. If the user clicks the OK button, is returned; otherwise, .

Gets a value that indicates whether the current OS supports Vista-style common file dialogs.

on Windows Vista or newer operating systems; otherwise, .

Gets or sets the descriptive text displayed above the tree view control in the dialog box, or below the list view control in the Vista style dialog.

The description to display. The default is an empty string ("").

Gets or sets the root folder where the browsing starts from. This property has no effect if the Vista style dialog is used.

One of the values. The default is Desktop. The value assigned is not one of the values.

Gets or sets the path selected by the user.

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 ("").

Gets or sets a value indicating whether the New Folder button appears in the folder browser dialog box. This property has no effect if the Vista style dialog is used; in that case, the New Folder button is always shown.

if the New Folder button is shown in the dialog box; otherwise, . The default is .

Gets or sets a value that indicates whether to use the value of the property as the dialog title for Vista style dialogs. This property has no effect on old style dialogs.

to indicate that the value of the property is used as dialog title; to indicate the value is added as additional text to the dialog. The default is .

A radio button on a task dialog.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified container.

The to add the to.

Gets or sets a value that indicates whether the radio button is checked.

if the radio button is checked; otherwise, . The default value is . Setting this property while the dialog is being displayed has no effect. Instead, use the method to check a particular radio button.

Gets the collection that items of this type are part of.

If the is currently associated with a , the collection of that ; otherwise, .

Indicates the icon to use for a task dialog.

A custom icon or no icon if no custom icon is specified.

System warning icon.

System Error icon.

System Information icon.

Shield icon.

Provides data for the event.

Initializes a new instance of the class with the specified expanded state.

if the the expanded content on the dialog is shown; otherwise, .

Gets a value that indicates if the expanded content on the dialog is shown.

if the expanded content on the dialog is shown; otherwise, .

Represents a dialog box that allows the user to enter generic credentials.

This class is meant for generic credentials; it does not provide access to all the functionality of the Windows CredUI API. Features such as Windows domain credentials or alternative security providers (e.g. smartcards or biometric devices) are not supported. The class provides methods for storing and retrieving credentials, and also manages automatic persistence of credentials by using the "Save password" checkbox on the credentials dialog. To specify the target for which the credentials should be saved, set the property. This class requires Windows XP or later.

Required designer variable.

Clean up any resources being used.

if managed resources should be disposed; otherwise, .

Required method for Designer support - do not modify the contents of this method with the code editor.

Initializes a new instance of the class.

Initializes a new instance of the class with the specified container.

The to add the component to.

Shows the credentials dialog as a modal dialog.

if the user clicked OK; otherwise, . The credentials dialog will not be shown if one of the following conditions holds: is and the application instance credential cache contains credentials for the specified , even if is . is , is , and the operating system credential store for the current user contains credentials for the specified . In these cases, the , and properties will be set to the saved credentials and this function returns immediately, returning . If the property is , you should call after validating if the provided credentials are correct. An error occurred while showing the credentials dialog. is an empty string ("").

Shows the credentials dialog as a modal dialog with the specified owner.

The that owns the credentials dialog. if the user clicked OK; otherwise, . The credentials dialog will not be shown if one of the following conditions holds: is and the application instance credential cache contains credentials for the specified , even if is . is , is , and the operating system credential store for the current user contains credentials for the specified . In these cases, the , and properties will be set to the saved credentials and this function returns immediately, returning . If the property is , you should call after validating if the provided credentials are correct. An error occurred while showing the credentials dialog. is an empty string ("").

Confirms the validity of the credential provided by the user.

if the credentials that were specified on the dialog are valid; otherwise, . Call this function after calling when is . Only when this function is called with set to will the credentials be saved in the credentials store and/or the application instance credential cache. was not called, or the user did not click OK, or was at the call, or the value of or was changed after the call. There was an error saving the credentials.

Stores the specified credentials in the operating system's credential store for the currently logged on user.

The target name for the credentials. The credentials to store. is . -or- is . is an empty string (""). An error occurred storing the credentials. The property is ignored and will not be stored, even if it is not . If the credential manager already contains credentials for the specified , they will be overwritten; this can even overwrite credentials that were stored by another application. Therefore it is strongly recommended that you prefix the target name to ensure uniqueness, e.g. using the form "Company_ApplicationName_www.example.com".

Retrieves credentials for the specified target from the operating system's credential store for the current user.

The target name for the credentials. The credentials if they were found; otherwise, . If the requested credential was not originally stored using the class (but e.g. by another application), the password may not be decoded correctly. This function does not check the application instance credential cache for the credentials; for that you can use the function. is . is an empty string (""). An error occurred retrieving the credentials.

Tries to get the credentials for the specified target from the application instance credential cache.

The target for the credentials, typically a server name. The credentials that were found in the application instance cache; otherwise, . This function will only check the the application instance credential cache; the operating system's credential store is not checked. To retrieve credentials from the operating system's store, use . is . is an empty string ("").

Deletes the credentials for the specified target.

The name of the target for which to delete the credentials. if the credential was deleted from either the application instance cache or the operating system's store; if no credentials for the specified target could be found in either store. The credentials for the specified target will be removed from the application instance credential cache and the operating system's credential store. is . is an empty string (""). An error occurred deleting the credentials from the operating system's credential store.

Raises the event.

The containing data for the event.

Raises the event.

The containing data for the event.

Event raised when the property changes.

Event raised when the property changes.

Gets or sets whether to use the application instance credential cache.

when credentials are saved in the application instance cache; if they are not. The default value is . The application instance credential cache stores credentials in memory while an application is running. When the application exits, this cache is not persisted. When the property is set to , credentials that are confirmed with when the user checked the "save password" option will be stored in the application instance cache as well as the operating system credential store. When is called, and credentials for the specified are already present in the application instance cache, the dialog will not be shown and the cached credentials are returned, even if is . The application instance credential cache allows you to prevent prompting the user again for the lifetime of the application if the "save password" checkbox was checked, but when the application is restarted you can prompt again (initializing the dialog with the saved credentials). To get this behaviour, the property must be set to .

Gets or sets whether the "save password" checkbox is checked.

if the "save password" is checked; otherwise, . The default value is . The value of this property is only valid if the dialog box is displayed with a save checkbox. Set this property before showing the dialog to determine the initial checked value of the save checkbox.

Gets the password the user entered in the dialog.

The password entered in the password field of the credentials dialog.

Gets the user-specified user name and password in a object.

A instance containing the user name and password specified on the dialog.

Gets the user name the user entered in the dialog.

The user name entered in the user name field of the credentials dialog. The default value is an empty string ("").

Gets or sets the target for the credentials, typically a server name.

The target for the credentials. The default value is an empty string (""). Credentials are stored on a per user, not on a per application basis. To ensure that credentials stored by different applications do not conflict, you should prefix the target with an application-specific identifer, e.g. "Company_Application_target".

Gets or sets the title of the credentials dialog.

The title of the credentials dialog. The default value is an empty string (""). This property is not used on Windows Vista and newer versions of windows; the window title will always be "Windows Security" in that case.

Gets or sets a brief message to display in the dialog box.

A brief message that will be displayed in the dialog box. The default value is an empty string (""). On Windows Vista and newer versions of Windows, this text is displayed using a different style to set it apart from the other text. In the default style, this text is a slightly larger and colored blue. The style is identical to the main instruction of a task dialog. On Windows XP, this text is not distinguished from other text. It's display mode depends on the property.

Gets or sets additional text to display in the dialog.

Additional text to display in the dialog. The default value is an empty string (""). On Windows Vista and newer versions of Windows, this text is placed below the text. On Windows XP, how and if this text is displayed depends on the value of the property.

Gets or sets a value that indicates how the text of the and properties is displayed on Windows XP.

One of the values of the enumeration. The default value is . Windows XP does not support the distinct visual style of the main instruction, so there is no visual difference between the text of the and properties. Depending on your requirements, you may wish to hide either the main instruction or the content text. This property has no effect on Windows Vista and newer versions of Windows.

Gets or sets a value that indicates whether a check box is shown on the dialog that allows the user to choose whether to save the credentials or not.

when the "save password" checkbox is shown on the credentials dialog; otherwise, . The default value is . When this property is set to , you must call the method to save the credentials. When this property is set to , the credentials will never be saved, and you should not call the method.

Gets or sets a value that indicates whether the dialog should be displayed even when saved credentials exist for the specified target.

if the dialog is displayed even when saved credentials exist; otherwise, . The default value is . This property applies only when the property is . Note that even if this property is , if the proper credentials exist in the application instance credentials cache the dialog will not be displayed.

Gets a value that indicates whether the current credentials were retrieved from a credential store.

if the current credentials returned by the , , and properties were retrieved from either the application instance credential cache or the operating system's credential store; otherwise, . You can use this property to determine if the credentials dialog was shown after a call to . If the dialog was shown, this property will be ; if the credentials were retrieved from the application instance cache or the credential store and the dialog was not shown it will be . If the property is set to , and the dialog is shown but populated with stored credentials, this property will still return .

Provides data for the event.

Initializes a new instance of the class with the specified tick count.

The tick count.

Gets or sets a value that indicates whether the tick count should be reset.

to reset the tick count after the event handler returns; otherwise, . The default value is .

Gets the current tick count of the timer.

The number of milliseconds that has elapsed since the dialog was created or since the last time the event handler returned with the property set to .

Represents a dialog that can be used to report progress to the user.

This class provides a wrapper for the native Windows IProgressDialog API. The class requires Windows 2000, Windows Me, or newer versions of Windows.

Initializes a new instance of the class.

Initializes a new instance of the class, adding it to the specified container.

The to which the component should be added.

Displays the progress dialog as a modeless dialog.

This function will not block the parent window and will return immediately. Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog will not function correctly unless the UI thread continues to handle window messages, so that thread may not be blocked by some other activity. All processing related to the progress dialog must be done in the event handler. The animation specified in the property could not be loaded.

Displays the progress dialog as a modeless dialog.

A parameter for use by the background operation to be executed in the event handler. This function will not block the parent window and return immediately. Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog will not function correctly unless the UI thread continues to handle window messages, so that thread may not be blocked by some other activity. All processing related to the progress dialog must be done in the event handler. The animation specified in the property could not be loaded.

Displays the progress dialog as a modal dialog.

The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However, the function for the class will return immediately. The parent window will be disabled as with all modal dialogs. Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog will not function correctly unless the UI thread continues to handle window messages, so that thread may not be blocked by some other activity. All processing related to the progress dialog must be done in the event handler. The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs, but is part of the underlying native progress dialog API so cannot be avoided. When possible, it is recommended that you use a modeless dialog using the function. The animation specified in the property could not be loaded.

Displays the progress dialog as a modal dialog.

The window that owns the dialog. The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However, the function for the class will return immediately. The parent window will be disabled as with all modal dialogs. Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog will not function correctly unless the UI thread continues to handle window messages, so that thread may not be blocked by some other activity. All processing related to the progress dialog must be done in the event handler. The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs, but is part of the underlying native progress dialog API so cannot be avoided. When possible, it is recommended that you use a modeless dialog using the function. The animation specified in the property could not be loaded, or the operation is already running.

Displays the progress dialog as a modal dialog.

The window that owns the dialog. A parameter for use by the background operation to be executed in the event handler. The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However, the function for the class will return immediately. The parent window will be disabled as with all modal dialogs. Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog will not function correctly unless the UI thread continues to handle window messages, so that thread may not be blocked by some other activity. All processing related to the progress dialog must be done in the event handler. The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs, but is part of the underlying native progress dialog API so cannot be avoided. When possible, it is recommended that you use a modeless dialog using the function. The animation specified in the property could not be loaded, or the operation is already running.

Updates the dialog's progress bar.

The percentage, from 0 to 100, of the operation that is complete. Call this method from the event handler if you want to report progress. This method has no effect is is or . is out of range. The progress dialog is not currently being displayed.

Updates the dialog's progress bar.

The percentage, from 0 to 100, of the operation that is complete. The new value of the progress dialog's primary text message, or to leave the value unchanged. The new value of the progress dialog's additional description message, or to leave the value unchanged. Call this method from the event handler if you want to report progress. is out of range. The progress dialog is not currently being displayed.

Updates the dialog's progress bar.

The percentage, from 0 to 100, of the operation that is complete. The new value of the progress dialog's primary text message, or to leave the value unchanged. The new value of the progress dialog's additional description message, or to leave the value unchanged. A state object that will be passed to the event handler. Call this method from the event handler if you want to report progress. is out of range. The progress dialog is not currently being displayed.

Raises the event.

The containing data for the event.

Raises the event.

The containing data for the event.

Raises the event.

The containing data for the event.

Required designer variable.

Clean up any resources being used.

if managed resources should be disposed; otherwise, .

Required method for Designer support - do not modify the contents of this method with the code editor.

Event raised when the dialog is displayed.

Use this event to perform the operation that the dialog is showing the progress for. This event will be raised on a different thread than the UI thread.

Event raised when the operation completes.

Event raised when is called.

Gets or sets the text in the progress dialog's title bar.

The text in the progress dialog's title bar. The default value is an empty string. This property must be set before or is called. Changing property has no effect while the dialog is being displayed.

Gets or sets a short description of the operation being carried out.

A short description of the operation being carried. The default value is an empty string. This is the primary message to the user. This property can be changed while the dialog is running, but may only be changed from the thread which created the progress dialog. The recommended method to change this value while the dialog is running is to use the method.

Gets or sets a value that indicates whether path strings in the property should be compacted if they are too large to fit on one line.

to compact path strings if they are too large to fit on one line; otherwise, . The default value is . This property requires Windows Vista or later. On older versions of Windows, it has no effect. This property can be changed while the dialog is running, but may only be changed from the thread which created the progress dialog.

Gets or sets additional details about the operation being carried out.

Additional details about the operation being carried out. The default value is an empty string. This text is used to provide additional details beyond the property. This property can be changed while the dialog is running, but may only be changed from the thread which created the progress dialog. The recommended method to change this value while the dialog is running is to use the method.

Gets or sets a value that indicates whether path strings in the property should be compacted if they are too large to fit on one line.

to compact path strings if they are too large to fit on one line; otherwise, . The default value is . This property requires Windows Vista or later. On older versions of Windows, it has no effect. This property can be changed while the dialog is running, but may only be changed from the thread which created the progress dialog.

Gets or sets the text that will be shown after the Cancel button is pressed.

The text that will be shown after the Cancel button is pressed. This property must be set before or is called. Changing property has no effect while the dialog is being displayed.

Gets or sets a value that indicates whether an estimate of the remaining time will be shown.

if an estimate of remaining time will be shown; otherwise, . The default value is . This property must be set before or is called. Changing property has no effect while the dialog is being displayed.

Gets or sets a value that indicates whether the dialog has a cancel button.

if the dialog has a cancel button; otherwise, . The default value is . This property requires Windows Vista or later; on older versions of Windows, the cancel button will always be displayed. The event handler for the event must periodically check the value of the property to see if the operation has been cancelled if this property is . Setting this property to is not recommended unless absolutely necessary.

Gets or sets a value that indicates whether the progress dialog has a minimize button.

if the dialog has a minimize button; otherwise, . The default value is . This property has no effect on modal dialogs (which do not have a minimize button). It only applies to modeless dialogs shown by using the method. This property must be set before is called. Changing property has no effect while the dialog is being displayed.

Gets a value indicating whether the user has requested cancellation of the operation.

if the user has cancelled the progress dialog; otherwise, . The default is . The event handler for the event must periodically check this property and abort the operation if it returns .

Gets or sets the animation to show on the progress dialog.

An instance of which specifies the animation to show, or to show no animation. The default value is . This property has no effect on Windows Vista or later. On Windows XP, this property will default to a flying papers animation. This property must be set before or is called. Changing property has no effect while the dialog is being displayed.

Gets or sets a value that indicates whether a regular or marquee style progress bar should be used.

One of the values of . The default value is . Operating systems older than Windows Vista do not support marquee progress bars on the progress dialog. On those operating systems, the progress bar will be hidden completely if this property is . When this property is set to , use the method to set the value of the progress bar. When this property is set to you can still use the method to update the text of the dialog, but the percentage will be ignored. This property must be set before or is called. Changing property has no effect while the dialog is being displayed.

Gets a value that indicates whether the is running an asynchronous operation.

if the is running an asynchronous operation; otherwise, .

Provides data for the event.

Initializes a new instance of the class with the specified item.

The that was clicked.

Gets the item that was clicked.

The that was clicked.

Represents the type of a task dialog button.

The button is a custom button.

The button is the common OK button.

The button is the common Yes button.

The button is the common No button.

The button is the common Cancel button.

The button is the common Retry button.

The button is the common Close button.

Represents the state of the progress bar on the task dialog.

Normal state.

Error state

Paused state

Class that provides data for the event.

Creates a new instance of the class with the specified URL.

The URL of the hyperlink.

Gets the URL of the hyperlink that was clicked.

The value of the href attribute of the hyperlink.