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

# TCustomButton.ModalResult

Value returned when the control is clicked in a modal form.

## Declaration

Source position: stdctrls.pp line 1256

`public property TCustomButton.ModalResult : TModalResult read FModalResult write SetModalResult default mrNone;`

## Description

ModalResult is a TModalResult property used to provide the modal result value when the button control is clicked in a modal form.

The value in ModalResult is used in the Click method to update the ModalResult value in the parent form (when assigned). The default value for the property is mrNone, and indicates that the property value is not used as a modal result in the Click method.

By convention, the value in ModalResult is associated with the usage and caption for the button control. Common values and usage in ModalResult includes:

mrNone
  ModalResult is not used.
mrOK
  The OK button was clicked.
mrCancel
  The Cancel button was clicked.
mrAbort
  The Abort button was clicked or the modal dialog was aborted.
mrRetry
  The Retry button was clicked.
mrIgnore
  The Ignore button was clicked.
mrYes
  The Yes button was clicked.
mrNo
  The No button was clicked.
mrAll
  The All button was clicked.
mrNoToAll
  The No To All button was clicked.
mrYesToAll
  The Yes To All button was clicked.
mrClose
  The Close button was clicked.