Skip to end of metadata
Go to start of metadata

Availability

This routine is available starting with SIL Engine™ 2.5.19 / 2.6.11.

Syntax

admAddFieldToScreen(scrName, fieldAsStr)

or
admAddFieldToScreen(scrName, fieldAsStr, scrTabName)

or
admAddFieldToScreen(scrName, fieldAsStr, scrTabName, indexInTab)

Description

Adds a field(custom field or system field) to a screen.

Parameters

Parameter name

Type

Required

Description

scrNamestringyesScreen name.
fieldAsStrstringyesField as a string(the field id for system fields, the field id as string, the field name or alias for custom fields).
scrTabNamestringnoTab name(if not provided, the first tab will be used to add the field).
indexInTabnumbernoPosition in tab(if not provided, or -1, the field will be the last in the tab).

Return type

string

Returns 'true' if the field is successfully added to the screen and 'false' otherwise.

The method throws an exception if the screen name or field parameters are empty or don't refer to a valid screen/field. Also an exception is thrown if the field is already presented in the screen.

If the tab name is provided and a tab with this name does't exist in the screen, it will be created and added as the last tab in the screen.

Example

Example 1

Adding a system field to a screen, in the first tab, default(last position) in tab:

admAddFieldToScreen("TestScreen", "priority");

Example 2

Adding a system field to a screen, in the tab "TestTab", first position in tab:

admAddFieldToScreen("TestScreen", "priority", "TestTab", 0);

Example 3

Adding a custom field to a screen, in the tab "TestTab", default(last) position in tab:

admAddFieldToScreen("TestScreen", "customfield_10000", "TestTab");
 

See also