Vcl.Controls.IsAnAllResult

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function IsAnAllResult(const AModalResult: TModalResult): Boolean;

C++

extern DELPHI_PACKAGE bool __fastcall IsAnAllResult(const System::Uitypes::TModalResult AModalResult);

Properties

Type Visibility Source Unit Parent
function public
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls Vcl.Controls

Description

Checks the return value from a modal form dialog and indicates whether the user selected All, Yes to All, or No to All.

Call IsAnAllResult to check whether the user closed a modal form by indicating a response that applies to "all". Pass the return value from the form's ShowModal method as the AModalResult argument. IsAnAllResult returns true if AModalResult is mrAll, mrNoToAll, or mrYesToAll, false otherwise.

Note: If IsAnAllResult returns true, you can convert the result to a simple Ok, No, or Yes result by calling StripAllFromResult.

See Also