Click or drag to resize

TaskDialog Class

Displays a Task Dialog.
Inheritance Hierarchy

Namespace:  Ookii.Dialogs
Assembly:  Ookii.Dialogs (in Ookii.Dialogs.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class TaskDialog : Component, IWin32Window

The TaskDialog type exposes the following members.

Constructors
  NameDescription
Public methodTaskDialog
Initializes a new instance of the TaskDialog class.
Public methodTaskDialog(IContainer)
Initializes a new instance of the TaskDialog class with the specified container.
Top
Properties
  NameDescription
Public propertyAllowDialogCancellation
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.
Public propertyButtons
Gets a list of the buttons on the Task Dialog.
Public propertyButtonStyle
Gets or sets a value that indicates whether custom buttons should be displayed as normal buttons or command links.
Protected propertyCanRaiseEvents
Gets a value indicating whether the component can raise an event.
(Inherited from Component.)
Public propertyCenterParent
Gets or sets a value that indicates whether the dialog is centered in the parent window instead of the screen.
Public propertyCollapsedControlText
Gets or sets the text to use for the control for expading the expandable information specified in ExpandedInformation.
Public propertyContainer
Gets the IContainer that contains the Component.
(Inherited from Component.)
Public propertyContent
Gets or sets the dialog's primary content.
Public propertyCustomFooterIcon
Gets or sets a custom icon to display in the footer area of the task dialog.
Public propertyCustomMainIcon
Gets or sets a custom icon to display in the dialog.
Protected propertyDesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Public propertyEnableHyperlinks
Gets or sets a value that indicates whether hyperlinks are allowed for the Content, ExpandedInformation and Footer properties.
Protected propertyEvents
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
Public propertyExpandedByDefault
Gets or sets a value that indicates that the string specified by the ExpandedInformation property should be displayed by default.
Public propertyExpandedControlText
Gets or sets the text to use for the control for collapsing the expandable information specified in ExpandedInformation.
Public propertyExpandedInformation
Gets or sets additional information to be displayed on the dialog.
Public propertyExpandFooterArea
Gets or sets a value that indicates that the string specified by the ExpandedInformation property should be displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content.
Public propertyFooter
Gets or sets the text to be used in the footer area of the task dialog.
Public propertyFooterIcon
Gets or sets the icon to display in the footer area of the task dialog.
Public propertyHandle
Gets the window handle of the task dialog.
Public propertyIsVerificationChecked
Gets or sets a value that indicates whether the verification checkbox is checked ot not.
Public propertyMainIcon
Gets or sets the icon to display in the task dialog.
Public propertyMainInstruction
Gets or sets the dialog's main instruction.
Public propertyMinimizeBox
Gets or sets a value that indicates whether the dialog has a minimize box on its caption bar.
Public propertyStatic memberOSSupportsTaskDialogs
Gets a value that indicates whether the current operating system supports task dialogs.
Public propertyProgressBarMarqueeAnimationSpeed
Gets or sets the marquee animation speed of the progress bar in milliseconds.
Public propertyProgressBarMaximum
Gets or sets the upper bound of the range of the task dialog's progress bar.
Public propertyProgressBarMinimum
Gets or sets the lower bound of the range of the task dialog's progress bar.
Public propertyProgressBarState
Gets or sets the state of the task dialog's progress bar.
Public propertyProgressBarStyle
Gets or sets the type of progress bar displayed on the dialog.
Public propertyProgressBarValue
Gets or sets the current value of the task dialog's progress bar.
Public propertyRadioButtons
Gets a list of the radio buttons on the Task Dialog.
Public propertyRaiseTimerEvent
Gets or sets a value that indicates whether the Timer event is raised periodically while the dialog is visible.
Public propertyRightToLeft
Gets or sets a value that indicates whether text is displayed right to left.
Public propertySite
Gets or sets the ISite of the Component.
(Inherited from Component.)
Public propertyTag
Gets or sets an object that contains data about the dialog.
Public propertyVerificationText
Gets or sets the label for the verification checkbox.
Public propertyWidth
Specifies the width of the task dialog's client area in DLU's.
Public propertyWindowIcon
Gets or sets the icon to be used in the title bar of the dialog.
Public propertyWindowTitle
Gets or sets the window title of the task dialog.
Top
Methods
  NameDescription
Public methodClickVerification
Simulates a click on the verification checkbox of the TaskDialog, if it exists.
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDispose
Releases all resources used by the Component.
(Inherited from Component.)
Protected methodDispose(Boolean)
Clean up any resources being used.
(Overrides ComponentDispose(Boolean).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodGetService
Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Protected methodOnButtonClicked
Raises the ButtonClicked event.
Protected methodOnCreated
Raises the Created event.
Protected methodOnDestroyed
Raises the Destroyed event.
Protected methodOnExpandButtonClicked
Raises the ExpandButtonClicked event.
Protected methodOnHelpRequested
Raises the HelpRequested event.
Protected methodOnHyperlinkClicked
Raises the HyperlinkClicked event.
Protected methodOnRadioButtonClicked
Raises the RadioButtonClicked event.
Protected methodOnTimer
Raises the Timer event.
Protected methodOnVerificationClicked
Raises the VerificationClicked event.
Public methodShow
Shows the task dialog as a modeless dialog.
Public methodShowDialog
Shows the task dialog as a modal dialog.
Public methodShowDialog(IWin32Window)
This method is for internal Ookii.Dialogs use and should not be called from your code.
Public methodToString
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
Top
Events
  NameDescription
Public eventButtonClicked
Event raised when the user clicks a button on the task dialog.
Public eventCreated
Event raised when the task dialog has been created.
Public eventDestroyed
Event raised when the task dialog has been destroyed.
Public eventDisposed
Occurs when the component is disposed by a call to the Dispose method.
(Inherited from Component.)
Public eventExpandButtonClicked
Event raised when the user clicks the expand button on the task dialog.
Public eventHelpRequested
Event raised when the user presses F1 while the dialog has focus.
Public eventHyperlinkClicked
Event raised when the user clicks a hyperlink.
Public eventRadioButtonClicked
Event raised when the user clicks a radio button on the task dialog.
Public eventTimer
Event raised periodically while the dialog is displayed.
Public eventVerificationClicked
Event raised when the user clicks the verification check box.
Top
Extension Methods
  NameDescription
Public Extension MethodExtendFrameIntoClientArea
Extends the glass window frame into the client area of the specified window.
(Defined by Glass.)
Top
Remarks
The task dialog contains an application-defined message text and title, icons, and any combination of predefined push buttons. Task Dialogs are supported only on Windows Vista and above. No fallback is provided; if you wish to use task dialogs and support operating systems older than Windows Vista, you must provide a fallback yourself. Check the OSSupportsTaskDialogs property to see if task dialogs are supported. It is safe to instantiate the TaskDialog class on an older OS, but calling Show or ShowDialog will throw an exception.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also