4D Doc Center : FORM GET OBJECTS

Home

4D v14.3

FORM GET OBJECTS


FORM GET OBJECTS ( objectsArray {; variablesArray {; pagesArray}} {; *} )

Parameter	Type	Description
objectsArray	String array	Name of form objects
variablesArray	Pointer array	Pointers to variables or fields associated with objects
pagesArray	Integer array	Page number of each object
*	Operator	If passed = reduce to the current page

Description

The FORM GET OBJECTS command returns the list of all objects present in the current form in the form of (an) array(s). This list can be restricted to the current form page. The command can be used with both input and output forms.

If an array passed as a parameter is not previously declared, the command creates it and automatically sets its size. However, in the interest of compiling the application, we recommend that you explicitly declare each array.

Pass the name of the string array that will contain object names (each object name is unique within a form) in objectsArray. The order in which objects appear in the array is not significant.

The other arrays optionally filled by the command are synchronized with the first array.

Pass the name of the pointer array that already contains pointers to variables or fields associated with objects in the optional variablesArray parameter. If an object does not have an associated variable, the pointer Nil is returned. If there is a “subform” type object, a pointer to the table of the subform is returned.

The third array (optional), pagesArray, is filled with the form page numbers. Each line of this array contains the page number of the corresponding object.
Objects coming from an inherited form are considered as belonging to page 0 of the current page.

The optional * parameter allows you to reduce the list of objects returned to the current page of the form. When this parameter is passed, only objects of the current page, page 0 and inherited pages are returned by the command. In other words, all the objects present in the current page of the form (visible or not) are processed by the command.