Skip to end of banner
Go to start of banner

BA_createCheckboxGroup

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Syntax:

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

optionsstring []YesThe list of selectable options.

defaultValue

string []

Yes

A sub-list of the options provided or an empty array

isDisabledbooleanYesSpecifies whether the field is read-only or not
isRequiredbooleanNoSpecifies 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.
fieldDescriptionstringNoA 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");


  • No labels