TScreen.FormIndex function

Declaration

function FormIndex(AForm: TForm): Integer

Arguments

Function result

Ordinal position in Forms for the TForm instance, or -1 when not found.

Description

FormIndex is an Integer function used to get the position in Forms where the specified TForm instance in located. It iterates over the values in Forms in reverse order. The return value contains the ordinal position in Forms where the TForm instance in AForm was found, or -1 when AForm does not exist in Forms.

Use the CustomFormIndex method to locate a form instance derived from TCustomForm in the CustomForms property.