TScreen.CustomFormIndex function

Declaration

function CustomFormIndex(AForm: TCustomForm): Integer

Arguments

Function result

The ordinal position for the form in CustomForms, or -1 when not found.

Description

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

Use the FormIndex method to locate a form instance derived from TForm in the Forms property.

See also

• CustomForms
• Forms
• FormIndex