4D v13.4

FORM GET NAMES

Home

 
4D v13.4
FORM GET NAMES

FORM GET NAMES 


 

FORM GET NAMES ( {aTable ;} arrNames {; filter}{; *} ) 
Parameter Type   Description
aTable  Table in Table reference
arrNames  Text array in Array of form names
filter  Text in Name filter
Operator in If passed = command applies to host database when executed from a component (parameter ignored outside of this context)

The FORM GET NAMES command fills the arrNames array with the names of forms in the application.

If you pass the aTable parameter, the command returns the names of the table forms associated with this table. If you omit this parameter, the command returns the names of the database project forms. 

You can limit this list of forms by passing a comparison string in the filter parameter: in this case, only forms whose names match the filter are returned. You can use the @ character in order to specify "starts with", "ends with" or "contains" type filters. If you pass an empty string, the filter parameter is ignored.

If the command is executed from a component, it returns by default the names of the component project forms. If you pass the * parameter, the array contains the forms of the host database. 

Note: Forms placed in the trash are not listed.

Example  

Examples of typical use:

  // List all the project forms of the database
 FORM GET NAMES(arr_Names)
 
  // List forms of the [Employees] table
 FORM GET NAMES([Employees] ;arr_Names)
 
  // List "input" forms of the [Employees] table
 FORM GET NAMES([Employees] ;arr_Names;"input_@")
 
  // List specific project forms of the database
 FORM GET NAMES(arr_Names;"dialogue_@")
 
  // List table forms from a component
  // A pointer is necessary because the table name is unknown
 FORM GET NAMES(tablePtr->;arr_Names;*)

 
PROPERTIES 

Product: 4D
Theme: Design Object Access
Number: 1167

 
INDEX

Alphabetical list of commands

 
HISTORY 

New
Created: 4D v13

 
SEE ALSO 

METHOD GET PATHS FORM