FORM GET OBJECTS

Home

4D v15

FORM GET OBJECTS

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

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
* \| formPageOption	Operator \| Longint	->	If * passed = reduce to the current page, or
			1=Form current page, 2=Form all pages, 4=Form inherited

Description

Originally introduced in 4D v14 R2

The FORM GET OBJECTS command ("Forms" theme) accepts the new formPageOption parameter that allows you to specify the form part(s) from where you want to get objects.

By default, if the formPageOption parameter is omitted (as well as the * parameter), objects from all pages, including inherited objects, are returned (as in previous releases of 4D).

To reduce the scope of the command, you can pass a value in formPageOption. You can pass one (or a combination) of the following constants, found in the "Form Objects (Access)" theme:

Constant	Type	Value	Description
Form current page	Longint	1	returns all objects of the current page, including page 0 but excluding inherited objects
Form all pages	Longint	2	returns all objects of all the pages, excluding inherited objects
Form inherited	Longint	4	returns inherited objects only

Note: Passing the * parameter is equivalent to passing Form current page+Form inherited. The syntax using the * parameter is now deprecated and should no longer be used.

Example 1

You want to get information on all pages including objects from the inherited form (if any):

  //open form

 FORM GET OBJECTS(objectsArray;variablesArray;pagesArray)

Or:

  //loaded form

 FORM LOAD([Table1];"MyForm")

 FORM GET OBJECTS(objectsArray;variablesArray;pagesArray;Form all pages+Form inherited)

Example 2

You want to get information on the current page only, with page 0 of the loaded form and inherited form objects (if any):

 FORM LOAD("MyForm")

 FORM GOTO PAGE(2)

 FORM GET OBJECTS(objectsArray;variablesArray;pagesArray;Form current page+Form inherited)

Example 3

You want to get information on all objects in the inherited form (if any). If there is no inherited form, arrays will be returned empty.

 FORM LOAD("MyForm")

 FORM GET OBJECTS(objectsArray;variablesArray;pagesArray;Form inherited)

Example 4

You want to get information on page 4 objects, including page 0 objects, but without inherited form objects (if any):

 FORM LOAD([Table1];"MyForm")

 FORM GOTO PAGE(4)

 FORM GET OBJECTS(objectsArray;variablesArray;pagesArray;Form current page)

Example 5

You want to get information on objects on all pages, but without inherited form objects (if any):

 FORM LOAD([Table1];"MyForm")

 FORM GET OBJECTS(objectsArray;variablesArray;pagesArray;Form all pages)