TScreen.CustomFormBelongsToActiveGroup function

Member of TScreenpublicIn unit Forms

Checks whether the specified form is present in the Z-ordered list of forms.

Declaration

pascal

function CustomFormBelongsToActiveGroup(AForm: TCustomForm): Boolean

Arguments

AForm

Form instance to locate in the Z-ordered forms for the screen.

Function result

True if the form is used on the screen.

Description

The return value is True when ACustomForm is found in the CustomFormsZOrdered property and is not displayed as a modal form (FormState contains fsModal). The return value is False if ACustomForm is not found in CustomFormsZOrdered.

Used in widgetset classes to determine if a form is used and enabled on the screen.

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