Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter name

Type

Required

Description

scrNamestringyesThe screen Screen name.
fieldAsStrstringyesThe field Field as a string(the field id for system fields, the field id as string, the field name or alias for custom fields).
scrTabNamestringnoThe tab Tab name(if not provided, the first tab will be used to add the field).
indexInTabnumbernoThe position Position 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.

Info

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 present 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.

...