Sign in Join
FPDoc Onlineexperiment

TScreen.GetCurrentModalFormZIndex function

Member of TScreenpublicIn unit Forms

Returns the index of the top-most modal form in CustomFormsZOrdered.

Declaration

pascal
function GetCurrentModalFormZIndex: Integer

Function result

The index for the form, or -1 if no modal form is active.

Description

Visits the form instances in CustomFormsZOrdered to find the first TCustomForm instance with the value fsModal in its FormState property.

Returns -1 if a modal form is not found in the CustomFormsZOrdered property.

Called from the GetCurrentModalForm method.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.