Skip to content

TaskDialog Control Members

See Also

See Also


TaskDialog Control Members

Public Methods

Method Description
Public MethodAboutBox Displays the about box for the control.
Public MethodAddButton Adds a user-defined button to the task dialog's command area.
Public MethodAddInputBox Adds a user input box to the task dialog's command area.
Public MethodAddRadioButton Adds a user-defined radio button to the task dialog's command area.
Public MethodClickButton Simulates the action of a button click in the task dialog.
Public MethodClickRadioButton Simulates the action of a radio button click in the task dialog.
Public MethodCreateFromXML Creates a dialog from an XML resource file.
Public MethodEnableButton Enables or disables a button in the task dialog.
Public MethodEnableRadioButton Enables or disables a radio button in the task dialog.
Public MethodReset Resets the configuration attributes for the task dialog to the default state.
Public MethodSetProgressBarRange Sets the minimum and maximum values for the progress bar.
Public MethodShowDialog Displays the task dialog and returns the selected button when done.
Public MethodStartProgressBarMarquee Specifies whether the progress bar should be displayed in marquee mode or not, with the ability to determine marquee speed as well.

Public Properties

Property Description
Public PropertyAllowCancellation Gets or sets whether to allow dialog cancellation for the task dialog.
Public PropertyCollapsedControlText Gets or sets the collapsed control text for the task dialog. This property is ignored unless ExpandedInformationText has been set.
Public PropertyCommonButtons Specifies the "common" push buttons displayed in the task dialog. If no common buttons are specified and no custom buttons are specified using the AddButton method, the task dialog will contain the "OK" button by default.
Public PropertyContentText Gets or sets the content text for the task dialog.
Public PropertyDefaultButton Gets or sets the default button ID for the task dialog.
Public PropertyDefaultRadioButton Gets or sets the default radio button ID for the task dialog.
Public PropertyDialogWidth Gets or sets the width of the task dialog's client area.
Public PropertyEnableCallbackTimer Enables or disables the callback timer for this task dialog.
Public PropertyEnableCommandLinks Specifies whether the buttons should be displayed as command links (using a standard task dialog glyph) instead of push buttons. This property is ignored if AddButton has not been called.
Public PropertyEnableHyperlinks Enables hyperlink displaying and processing for the strings specified for the ContentText, ExpandedInformationText, and FooterText properties.
Public PropertyEnableMarkup Allows the use of a XAML snippet to be used for the Caption of this control.
Public PropertyExpandedByDefault Gets or sets whether to display expanded information at the bottom of the task dialog's footer. This property is ignored unless ExpandedInformationText has been set.
Public PropertyExpandedControlText Gets or sets the expanded control text for the task dialog. This property is ignored unless ExpandedInformationText has been set.
Public PropertyExpandedInformationText Gets or sets the expanded information text for the task dialog.
Public PropertyExpandFooterArea Gets or sets whether to display expanded information at the bottom of the task dialog's footer. This function is ignored if the ExpandedInformationText property has not been set.
Public PropertyFooterIcon Gets or sets the icon for the Footer area of the task dialog.
Public PropertyFooterIconHandle Gets or sets the handle for a custom icon for the Footer area of the task dialog.
Public PropertyFooterText Gets or sets the footer text for the task dialog.
Public PropertyInputBoxText Gets or sets the text entered by the user in the input box field or sets the default value for the input box field.
Public PropertyMainIcon Gets or sets the icon for the Main Instruction area of the task dialog.
Public PropertyMainIconHandle Gets or sets the handle for a custom icon for the Main Instruction area of the task dialog.
Public PropertyMainInstructionText Gets or sets the main instruction text for the task dialog.
Public PropertyMarkupContext Connects events in XML Markup with actual methods, functions, and events in your code.
Public PropertyMessageBoxStyle Specifies whether to show the dialog using the Windows XP or Windows Vista style even if the standard window theme or no manifest is used.
Public PropertyParentHwnd Gets or sets the handle to the parent window for the task dialog.
Public PropertyProgressBarPos Gets or sets the current position for the progress bar.
Public PropertyProgressBarStyle Gets or sets the style of the progress bar. This is used to display the progress bar and specifies whether the progress bar should be displayed in marquee mode or not.
Public PropertyRelativePosition Specifies whether to position the task dialog relative to the parent window.
Public PropertyRtlLayout Enables or disables right to left text display for the task dialog.
Public PropertyShowCommandLinkIcons Specifies whether the command links should display an icon next to the button text.
Public PropertyUseComCtl32 Gets or sets whether to use the ComCtl32.dll (Windows Vista) version of Task Dialog.
Public PropertyVerificationText Gets or sets the label for the verification checkbox to be displayed in the task dialog.
Public PropertyVerifyCheckState Gets or sets the checked state for the verification checkbox when the dialog is initially displayed. This property is ignored if the VerificationText property has not been set.
Public PropertyWindowTitle Gets or sets the window title for the task dialog.

Events

Event Description
Public EventButtonClicked Occurs when a user selects a button or command link in the task dialog.
Public EventConstructed Occurs once the task dialog has been created and before it is displayed.
Public EventExpandButtonClicked Occurs when the user clicks on the expand button in the Task Dialog.
Public EventHyperlinkClicked Occurs when a user clicks on a hyperlink in the Task Dialog's content.
Public EventInputBoxChanged Occurs when the InputBoxText has changed in the input box.
Public EventRadioButtonClicked Occurs when a user selects a radio button in the task dialog.
Public EventTimer This event is sent by the Task Dialog approximately every 200 milliseconds when the EnableCallbackTimer property has been set.
Public EventVerificationClicked Occurs when the user clicks on the task dialog's verification checkbox.

See Also


Copyright (c) 1998-2024 Codejock Technologies. All rights reserved.