Syntax:
BA_createCheckboxGroup(label, options, defaultValues, isDisabled)
Since version 2.0.8 and 2.6.1:
BA_createCheckboxGroup(label, options, defaultValues, isDisabled[, isRequired, fieldDescription])
Description:
Creates a checkbox group.Parameters:
Parameter name | Type | Required | Description |
|---|---|---|---|
label | string | Yes | The label of the field |
| options | string [] | Yes | The list of selectable options. |
defaultValue | string [] | Yes | A sub-list of the options provided or an empty array |
| isDisabled | boolean | Yes | Specifies whether the field is read-only or not |
| isRequired | boolean | No | Specifies if the field is should be marked as required with a dark red asterisk. Note that marking the field as required does not add any validation. |
| fieldDescription | string | No | A description of the field to be displayed immediately under the input box. |
Return type:
string []
Examples:
Example 1:
BA_createCheckboxGroup("cbx 1", {"option 1", "option 2", "option 3"}, {"option 1", "option 3"}, true, false, "select some options");
BA_createCheckboxGroup("cbx 2", {"option 1", "option 2", "option 3"}, "option 1", false, true, "select some options");
