TaskDialogButton Class

Represents a custom button in a TaskDialog that can be added to the Buttons collection. The button can be either a regular push button or a command link, depending on the Options property flags.

Definition

Namespace: KGySoft.WinForms.Components
Assembly: KGySoft.WinForms (in KGySoft.WinForms.dll) Version: 5.0.1

C#

public sealed class TaskDialogButton : TaskDialogButtonBase

VB

Public NotInheritable Class TaskDialogButton
	Inherits TaskDialogButtonBase

C++

public ref class TaskDialogButton sealed : public TaskDialogButtonBase

F#

[<SealedAttribute>]
type TaskDialogButton = 
    class
        inherit TaskDialogButtonBase
    end

Inheritance: Object TaskDialogControl TaskDialogButtonBase TaskDialogButton

Constructors

TaskDialogButton	Creates a new instance of the TaskDialogButton class.
TaskDialogButton(String)	Creates a new instance of the TaskDialogButton class with the specified text.
TaskDialogButton(String, String)	Creates a new instance of the TaskDialogButton with the specified name and text.

Properties

CustomIcon	Gets ot sets a custom icon for this TaskDialogButton. Has effect only when TaskDialog is used in compatibility mode. If IsElevated is also set, the elevated icon is displayed.
Description	Gets or sets the description of the button. If the button is displayed as a command link, description is displayed under the main text. Otherwise, the description can be displayed as a tooltip (when the TaskDialog is used in compatibility mode). (Inherited from TaskDialogButtonBase)
Enabled	Gets or sets whether the button is enabled. (Inherited from TaskDialogButtonBase)
IsDefault	Gets or sets whether this button is the default button. If there are more default buttons in a collection, the first one will be the default button when the dialog appears. Default value: .
IsElevated	Gets or sets whether an elevated shield icon is displayed on the button. Default value: .
Name	Gets or sets the name of this control. Name is not required to be set, but it can be used to identify controls in a TaskDialogControlCollectionT by name. This property can be changed without restriction. (Inherited from TaskDialogControl)
Parent	Gets the parent dialog that is hosting the control. (Inherited from TaskDialogControl)
Tag	Gets or sets a tag for this TaskDialogControl. A tag can be any object for custom purposes. (Inherited from TaskDialogControl)
Text	Gets or sets the button text. (Inherited from TaskDialogButtonBase)

Methods

Dispose	Disposes this TaskDialogControl instance. (Inherited from TaskDialogControl)
ToString	Returns the string representation of this button. (Inherited from TaskDialogButtonBase)

Events

Click	Occurs when this TaskDialogButton is clicked. If not subscribed, the TaskDialog will be closed when the button is clicked. Otherwise, the Handled property can be set to to let the invoker side close the TaskDialog.
PropertyChanged	Occurs when a property value changes. (Inherited from TaskDialogControl)