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

# TDialogButton

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

Implements a standard dialog button.

## Declaration

Source position: interfacebase.pp line 80

`type TDialogButton = class(TCollectionItem)`
`protected`
`function GetDisplayName; override;` |  | Gets the value for the DisplayName property.
`procedure SetCaption(); virtual;` |  | Sets the value for the Caption property.
`public`
`constructor Create(); override;` |  | Constructor for the class instance.
`property Caption: string; [rw]` |  | Value displayed on the button face.
`property Cancel: Boolean; [rw]` |  | True if the button is the Cancel button.
`property Default: Boolean; [rw]` |  | True if the button is the default button.
`property ModalResult: LongInt; [rw]` |  | The modal result value returned when the button is clicked.
`end;`

## Inheritance

`TDialogButton` |  | Implements a standard dialog button.
`TCollectionItem`
?
`TObject`

## Description

TDialogButton is a TCollectionItem descendant which implements a standard dialog button.

TDialogButton is the type created and stored in the TDialogButtons Collection. An overridden method is provided to use the Caption as the DisplayName for the collection item.

TDialogButton contains properties used to control how a dialog button button is displayed and used.

Caption contains the text displayed on the button face, and can define an accelerator key by prefixing a character with an Ampersand (&).

Cancels indicate if the dialog button is used as the Cancel button in the Collection.

Default indicates if the dialog button is the default button in the Collection.

## See also

TDialogButtons |  | Collection used to store TDialogButton instances.
TWidgetSet.AskUser |  | Displays a dialog box with the specified values, and returns the modal result.
TCollectionItem.Collection
TCollectionItem.DisplayName