Feedback
Last date modified: 2026-Apr-23
Form Settings Api
Represents an object that contains general settings related to the user viewing a form and the artifact displayed in it. These functions are available under the `convenienceApi.formSettings` namespace.
Methods
- getFormSettings() ⇒
FormSettings - Returns all the form settings for the application.
Type Definitions
Properties Details
getFormSettings() ⇒ FormSettings
Returns all the form settings for the application.
Returns: FormSettings - An object that contains the form settings.
FormSettings
Properties
| Name | Type | Description |
|---|---|---|
| LoggedInUserID | Number
|
Represents the unique identifier for the currently active user. |
| ChoiceLimitForUI | Number
|
Indicates the maximum number of choices or single objects, which can appear in a checkbox, drop-down, or radio button list before the UI is switched to a pop-up picker. |
| IsLoggedInUserSystemAdmin | Boolean
|
Indicates whether the currently active user is a system administrator. |
| IsSystemType | Boolean
|
Indicates whether the current artifact type is a system type. |
| IsDynamicType | Boolean
|
Indicates whether the current artifact type is a dynamic type, such as a RDO. |
| DownloadHandlerApplicationPath | String
|
Contains the default URL referencing the code responsible for making downloaded files available to users. |
| TimeSettings | Object
|
Contains time settings, including the following: - IsDST - a <Boolean> that indicates whether the current locale uses Daylight Savings Time (DST). - ServerTimeOffsetHours - a <number> indicating the difference in hours between the current locale and the server. - ServerTimeOffsetMinutes - a <number> indicating the difference in minutes between the current locale and the server. |
