Sign in Join
FPDoc Onlineexperiment

TScreen.CustomFormZIndex function

Member of TScreenpublicIn unit Forms

Gets the position in CustomFormsZOrdered for the specified form.

Declaration

pascal
function CustomFormZIndex(AForm: TCustomForm): Integer

Arguments

AForm

Form instance to locate in CustomFormsZOrdered.

Function result

Position for the specified form in the Z-Order for the screen. 0 if the form is at the top of the Z-Order.

Description

The return value contains the z-order for the specified form, with the currently active form at index position zero (0).

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