C# Class TaskDialogInterop.TaskDialogOptions

Defines configuration options for showing a task dialog.
Show file Open project: Euclideon/WPF-Task-Dialog Class Usage Examples

Public Properties

Property Type Description
AllowDialogCancellation bool
Callback TaskDialogCallback
CallbackData object
CollapsedControlText string
CommandButtons string[]
CommonButtons TaskDialogCommonButtons
Content string
CustomButtons string[]
CustomFooterIcon System.Drawing.Icon
CustomMainIcon System.Drawing.Icon
Default TaskDialogOptions
DefaultButtonIndex int?
EnableCallbackTimer bool
ExpandToFooter bool
ExpandedByDefault bool
ExpandedControlText string
ExpandedInfo string
FooterIcon VistaTaskDialogIcon
FooterText string
MainIcon VistaTaskDialogIcon
MainInstruction string
Owner System.Windows.Window
RadioButtons string[]
ShowMarqueeProgressBar bool
ShowProgressBar bool
Title string
VerificationByDefault bool
VerificationText string

Property Details

AllowDialogCancellation public property

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 the CommonButtons.
You'll want to set this to true if you use CustomButtons and have a Cancel-like button in it.
public bool AllowDialogCancellation
return bool

Callback public property

A callback that receives messages from the Task Dialog when various events occur.
public TaskDialogCallback Callback
return TaskDialogCallback

CallbackData public property

Reference object that is passed to the callback.
public object CallbackData
return object

CollapsedControlText public property

The string to be used to label the button for expanding the expanded information. This member is ignored when the ExpandedInfo member is null. If this member is null and the ExpandedControlText is specified, then the ExpandedControlText value will be used for this member as well.
public string CollapsedControlText
return string

CommandButtons public property

Command link buttons.
public string[] CommandButtons
return string[]

CommonButtons public property

Standard buttons.
public TaskDialogCommonButtons CommonButtons
return TaskDialogCommonButtons

Content public property

Supplemental text that expands on the principal text.
public string Content
return string

CustomButtons public property

Buttons that are not from the set of standard buttons. Use an ampersand to denote an access key.
public string[] CustomButtons
return string[]

CustomFooterIcon public property

A small 16x16 icon that signifies the purpose of the footer text, using a custom Icon resource. If defined FooterIcon will be ignored.
public Icon,System.Drawing CustomFooterIcon
return System.Drawing.Icon

CustomMainIcon public property

A large 32x32 icon that signifies the purpose of the dialog, using a custom Icon resource. If defined MainIcon will be ignored.
public Icon,System.Drawing CustomMainIcon
return System.Drawing.Icon

Default public static property

The default T:TaskDialogOptions to be used by all new T:TaskDialogs.
Use this to make application-wide defaults, such as for the caption.
public static TaskDialogOptions,TaskDialogInterop Default
return TaskDialogOptions

DefaultButtonIndex public property

Zero-based index of the button to have focus by default.
public int? DefaultButtonIndex
return int?

EnableCallbackTimer public property

Indicates that the task dialog's callback is to be called approximately every 200 milliseconds.
Enable this in order to do updates on the task dialog periodically, such as for a progress bar, current download speed, or estimated time to complete, etc.
public bool EnableCallbackTimer
return bool

ExpandToFooter public property

Indicates that the expanded info should be displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content.
public bool ExpandToFooter
return bool

ExpandedByDefault public property

Indicates that the expanded info should be displayed when the dialog is initially displayed.
public bool ExpandedByDefault
return bool

ExpandedControlText public property

The string to be used to label the button for collapsing the expanded information. This member is ignored when the ExpandedInfo member is null. If this member is null and the CollapsedControlText is specified, then the CollapsedControlText value will be used for this member as well.
public string ExpandedControlText
return string

ExpandedInfo public property

Extra text that will be hidden by default.
public string ExpandedInfo
return string

FooterIcon public property

A small 16x16 icon that signifies the purpose of the footer text, using one of the built-in system icons.
public VistaTaskDialogIcon FooterIcon
return VistaTaskDialogIcon

FooterText public property

Additional footer text.
public string FooterText
return string

MainIcon public property

A large 32x32 icon that signifies the purpose of the dialog, using one of the built-in system icons.
public VistaTaskDialogIcon MainIcon
return VistaTaskDialogIcon

MainInstruction public property

Principal text.
public string MainInstruction
return string

Owner public property

The owner window of the task dialog box.
public System.Windows.Window Owner
return System.Windows.Window

RadioButtons public property

Application-defined options for the user.
public string[] RadioButtons
return string[]

ShowMarqueeProgressBar public property

Indicates that an Marquee Progress Bar is to be displayed.
You can set start and stop the animation by setting a callback and timer to control the dialog at custom intervals.
public bool ShowMarqueeProgressBar
return bool

ShowProgressBar public property

Indicates that a Progress Bar is to be displayed.
You can set the state, whether paused, in error, etc., as well as the range and current value by setting a callback and timer to control the dialog at custom intervals.
public bool ShowProgressBar
return bool

Title public property

Caption of the window.
public string Title
return string

VerificationByDefault public property

Indicates that the verification checkbox in the dialog is checked when the dialog is initially displayed.
public bool VerificationByDefault
return bool

VerificationText public property

Text accompanied by a checkbox, typically for user feedback such as Do-not-show-this-dialog-again options.
public string VerificationText
return string