| Info |
|---|
|
This routine is available starting with SIL Engine™ 2.5.19 / 2.6.11. |
Syntax
admAddFieldToScreen(scrName, fieldAsStr)
or
admAddFieldToScreen(scrName, fieldAsStr, scrTabName)
...
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| heading | 0 |
|---|
| columnTypes | s,s,s,s |
|---|
| multiple | false |
|---|
| columnAttributes | style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold, |
|---|
| enableSorting | false |
|---|
|
Syntax | admAddFieldToScreen(scrName, fieldAsStr [, scrTabName, indexInTab]) | Package | | Alias | | Pkg Usage | | |
Description
| Excerpt |
|---|
|
| Adds a field(custom field or system field) to a screen. |
Adds a field(custom field or system field) to a screen.
Parameters
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| columnTypes | s,s,s,s |
|---|
| heading | 0 |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
Parameter name | Type | Required | Description |
|---|
scrName | |
...
...
Yes | Screen name. | fieldAsStr |
|
...
...
Yes | Field as a string(the field id for system fields, the field id as string, the field name or alias for custom fields). | scrTabName |
|
...
...
No | Tab name(if not provided, the first tab will be used to add the field). | indexInTab | number |
|
...
No | Position in tab(if not provided, or -1, the field will be the last in the tab). |
|
Return
...
Type
stringString
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 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. |
...
Examples
Example 1
Adding a system field to a screen, in the first tab, default(last position) in tab:
| Code Block |
|---|
admAddFieldToScreen("TestScreen", "priority");
|
Example 2
Adding a system field to a screen, in the tab "TestTab", first position in tab:
| Code Block |
|---|
admAddFieldToScreen("TestScreen", "priority", "TestTab", 0);
|
Example 3
Adding a custom field to a screen, in the tab "TestTab", default(last) position in tab:
| Code Block |
|---|
admAddFieldToScreen("TestScreen", "customfield_10000", "TestTab");
|
...
| Note |
|---|
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. |
See also
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 15025 |
|---|
| showSpace | false |
|---|
| cql | label in ( = "jiracustomfield_fieldadmin_routine" , "jira_transition_routine" and space = currentSpace ( ) |
|---|
| labels | jira_field_routine jira_transition_routinearray_routines |
|---|
|