TTaskDialogButtonClickedEvent

Specifies a callback routine executed when a button is clicked on a task dialog.

Declaration

Source position: lcltaskdialog.pas line 186

type TTaskDialogButtonClickedEvent = procedure(

Sender: PTaskDialog;

AButtonID: Integer;

var ACanClose: Boolean

) of object;

Arguments

`Sender`		Handle to the task dialog form for the callback.
`AButtonID`		Button identifier for the callback notification.
`ACanClose`		Indicates if the dialog can be closed. Set to True in the callback implementation to allow the task dialog to be closed. Set to False to prevent closing the dialog.

Description

This callback will be triggered when a task dialog button is clicked. To prevent the task dialog from closing, the application must set ACanClose to False. Otherwise, the task dialog is closed and the button ID is returned via the original TTaskDialog.Execute() result.

TTaskDialogButtonClickedEvent is the type used to implement the OnButtonClicked event handler in the TTaskDialogImplementation and TTaskDialogEx record types. The type is also passed as an argument to the Execute method in TTaskDialog.

Version 3.2

Generated 2024-02-25

Home