System.UITypes.TModalResult

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

type TModalResult = Integer;

C++

typedef int TModalResult;

Properties

Type Visibility Source Unit Parent
type
typedef
public
System.UITypes.pas
System.UITypes.hpp
System.UITypes System.UITypes

Description

Determines whether and how a modal form is closed.

The following table lists the constants defined in the System.UITypes unit to be used with the TModalResult type.

Constant Value Meaning

mrNone

0

None. Used as a default value before the user exits.

mrOk

idOK = 1

The user exited with the OK button.

mrCancel

idCancel = 2

The user exited with the CANCEL button.

mrAbort

idAbort = 3

The user exited with the ABORT button.

mrRetry

idRetry = 4

The user exited with the RETRY button.

mrIgnore

idIgnore = 5

The user exited with the IGNORE button.

mrYes

idYes = 6

The user exited with the YES button.

mrNo

idNo = 7

The user exited with the NO button.

mrClose

idClose = 8

The user exited with the CLOSE button.

mrHelp

idHelp = 9

The user exited with the HELP button.

mrTryAgain

idTryAgain = 10

The user exited with the TRY AGAIN button.

mrContinue

idContinue = 11

The user exited with the CONTINUE button.

mrAll

mrContinue + 1 (12 or $C)

The user exited with the ALL button.

mrNoToAll

mrAll +1 (13 or $D)

The user exited with the NO TO ALL button.

mrYesToAll

mrNoToAll +1 (14 or $E)

The user exited with the YES TO ALL button.


You can check a TModalResult value using the global IsAbortResult, IsAnAllResult, IsNegativeResult, or IsPositiveResult functions and use the StripAllFromResult function to convert ModalResult values that refers to "ALL" buttons to values identifying corresponding simple buttons (Ok, No, or Yes).

See Also