[Overview][Types][Classes][Procedures and functions][Index] | Reference for unit 'StdActns' (#lcl)

# TCommonDialogAction

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Dialog action used to create, configure, display, and execute a dialog form.

## Declaration

Source position: stdactns.pas line 124

`type TCommonDialogAction = class(TCustomAction)`
`protected`
`FDialog: TCommonDialog;` |  | FDialog - local variable holding the Dialog associated with this action.
`procedure DoAccept;` |  | DoAccept - perform the code for the OnAccept event.
`procedure DoBeforeExecute;` |  | Performs the BeforeExecute notification event when assigned.
`procedure DoCancel;` |  | Signals the OnCancel event handler (when assigned).
`function GetDialogClass; virtual;` |  | Returns the class type for the dialog associated with this action.
`procedure CreateDialog; virtual;` |  | Create a new instance of the class type needed for the dialog in the action.
`public`
`constructor Create(); override;` |  | Constructor for the class instance.
`function Handlestarget(); override;` |  | Indicates whether the action is supported for the specified target.
`procedure ExecuteTarget(); override;` |  | Executes the action on the target control.
`property ExecuteResult: Boolean; [r]` |  | ExecuteResult - the result of the execution: True if successful.
`property BeforeExecute: TNotifyEvent; [rw]` |  | BeforeExecute - event handler for performance before execution of the action.
`property OnAccept: TNotifyEvent; [rw]` |  | OnAccept - event handler for a press of the Accept button.
`property OnCancel: TNotifyEvent; [rw]` |  | OnCancel - event handler for a press of the Cancel button.
`published`
`property OnUpdate;`
`end;`

## Inheritance

`TCommonDialogAction` |  | Dialog action used to create, configure, display, and execute a dialog form.
`TCustomAction` |  | TCustomAction is the ancestor class for TAction.
`TContainedAction` |  | Implements an Action class which has a category and parent action list.
`TBasicAction`
?
`TObject`

## Description

TCommonDialogAction is the base class for standard actions which display a dialog form, such as: TFileAction, TSearchAction, TFontEdit, TColorSelect.

TCommonDialogAction introduces methods used to get the class type for an associated dialog form, and to create the form instance displayed when the action is executed. It includes overridden methods to enable or execute the action for a target control. Event handlers are included which are signalled when the action is updated or executed, and to respond to accept and cancel buttons on its dialog form.

Do not create instances of TCommonDialogAction; use one of its descendent classes which provides the correct dialog form for the action.

## See also

TFileAction |  | TFileAction - base class for providing actions associated with various file dialogs and menu options.
TSearchAction |  | TSearchAction - base class for the actions associated with the various Search menu options.
TFontEdit |  | TFontEdit - standard action for opening a Font Edit dialog.
TColorSelect |  | TColorSelect - standard action for opening a Color Selection dialog.
TCustomAction |  | TCustomAction is the ancestor class for TAction.