| [Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] |
[Properties (by Name)] [Methods (by Name)] [Events (by Name)]
Defines a configurable, modal task dialog at run-time.
Source position: dialogs.pp line 615
type TCustomTaskDialog = class(TComponent) |
||
protected |
||
function DoExecute(); dynamic; |
|
Performs actions to configure and execute the dialog using the wrapper in the LCLTaskDialog unit. |
procedure DoOnButtonClicked(); dynamic; |
|
Signals the OnButtonClicked event handler (when assigned) for the button with the specified modal result value. |
public |
||
constructor Create(); override; |
|
Constructor for the class instance. |
destructor Destroy; override; |
|
Destructor for the class instance. |
function Execute(); |
|
Displays the dialog and captures the modal result value. |
property Button: TTaskDialogButtonItem; [rw] |
|
Not used in the current LCL version. |
property Buttons: TTaskDialogButtons; [rw] |
|
Collection with the buttons for the Task dialog. |
property Caption: TTranslateString; [rw] |
|
Caption text displayed on the title bar for the Task dialog. |
property CommonButtons: TTaskDialogCommonButtons; [rw] |
|
Set of common buttons displayed on the Task dialog. |
property DefaultButton: TTaskDialogCommonButton; [rw] |
|
Index of the default button, from the set in the CommonButtons property. |
property ExpandButtonCaption: TTranslateString; [rw] |
|
Caption displayed for the expand/collapse button on the dialog. |
property ExpandedText: TTranslateString; [rw] |
|
Text that is displayed in the expandable / collapsible area on the Task dialog. |
property Flags: TTaskDialogFlags; [rw] |
|
Set of options enabled for the Task dialog. |
property FooterIcon: TTaskDialogIcon; [rw] |
|
Icon for the footer area displayed at the bottom of the dialog. |
property FooterText: TTranslateString; [rw] |
|
Text that is displayed in the footer area on the Task dialog. |
property MainIcon: TTaskDialogIcon; [rw] |
|
Icon displayed beside the Title for the dialog. |
property ModalResult: TModalResult; [rw] |
|
Modal result value returned when the Task dialog was executed. |
property RadioButton: TTaskDialogRadioButtonItem; [r] |
|
The radio button selected in the Task dialog. |
property RadioButtons: TTaskDialogButtons; [rw] |
|
Collection with the optional radio buttons defined for the Task dialog. |
property Text: TTranslateString; [rw] |
|
Text displayed as main content for the Task dialog. |
property Title: TTranslateString; [rw] |
|
Header text displayed at the top of dialog, with a larger font size and using a bold font style. |
property VerificationText: TTranslateString; [rw] |
|
Optional caption text for the check box displayed at the bottom of the Task dialog. |
|
Sets the width in pixels for the task dialog form. |
|
property OnButtonClicked: TTaskDlgClickEvent; [rw] |
|
Event handler signalled for the button clicked when the Task dialog was executed. |
end; |
|
Defines a configurable, modal task dialog at run-time. |
|
| | | ||
| | | ||
| | | ||
TCustomTaskDialog is a TComponent descendant which defines a configurable, modal task dialog. It is a non-visual component which creates modal dialogs at run-time, with rich UI elements. It is a wrapper for LCLTaskDialog.TTaskDialog which implements the Windows TaskDialog API.
TCustomTaskDialog provides properties which can be used to configure the class instance at design-time in the object inspector. At run-time, the Execute method handles converting properties and calling routines in the LCLTaskDialog.TTaskDialog implementation.
|
Creates a configurable, modal task dialog at run-time. |
|
|
Implements a task dialog. |
| Version 3.2 | Generated 2024-02-25 | Home |