Reference › SmartApp › Page › Section › ModeSetting
A mode setting creates a control that allows the user to select one or more location modes. To allow the selection of only one mode:
section.modeSetting('targetMode')
To allow the selection of more than one mode:
section.modeSetting('permittedModes').multiple(true)
- closeOnSelection
- defaultValue
- description
- disabled
- multiple
- name
- required
- style
- submitOnChange
- translateDefaultValue
▸ closeOnSelection(value: boolean): ModeSetting
Specifies whether this input should close on selection.
Parameters:
| Name | Type |
|---|---|
value |
boolean |
Returns: ModeSetting
▸ defaultValue(value: string | number): ModeSetting
Inherited from SectionSetting.defaultValue
Sets the initial value displayed in the setting when first shown to the user.
Parameters:
| Name | Type |
|---|---|
value |
string | number |
Returns: ModeSetting
▸ description(value: string): ModeSetting
Inherited from SectionSetting.description
Sets value displayed in the setting control. Defaults to 'Tap to Set' for most types of settings.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: ModeSetting
▸ disabled(value: boolean): ModeSetting
Inherited from SectionSetting.disabled
Disables the ability to use the control
Parameters:
| Name | Type |
|---|---|
value |
boolean |
Returns: ModeSetting
▸ multiple(boolean: true): ModeSetting
Specifies whether this mode setting can have multiple values.
Parameters:
| Name | Type |
|---|---|
boolean |
true |
Returns: ModeSetting
▸ name(value: string): ModeSetting
Inherited from SectionSetting.name
Sets the name of this setting. Used to reference the setting value during the processing of events. Also used as part of the i18n key for translating the displayed name and description of the setting. All settings on a page must have unique names.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: ModeSetting
▸ required(value: boolean): ModeSetting
Inherited from SectionSetting.required
Specifies that the control must be set in order to save the configuration page
Parameters:
| Name | Type |
|---|---|
value |
boolean |
Returns: ModeSetting
▸ style(value: ModeStyle): ModeSetting
Set the style of the setting in the UI.
Parameters:
| Name | Type |
|---|---|
value |
ModeStyle |
Returns: ModeSetting
▸ submitOnChange(value: boolean): ModeSetting
Inherited from SectionSetting.submitOnChange
Causes the page to be submitted and re-rendered any time the value of the setting is changed, rather than requiring the user to tap Next or Done. This behavior is useful when the the presence or enabled/disabled status of some settings depend on the value of other settings.
Parameters:
| Name | Type |
|---|---|
value |
boolean |
Returns: ModeSetting
▸ translateDefaultValue(value: string): ModeSetting
Inherited from SectionSetting.translateDefaultValue
Sets the initial value of the setting by passing the specified value through the i18n translation process.
You might want to use translatedDefaultValue rather than defaultValue in a case like setting the
default value of a text setting to the word "Kitchen" in the language of the user. defaultValue('Kitchen')
will set the value "Kitchen" regardless of the user's language or whether there were localization file entries
for the key "Kitchen". However, translateDefaultValue('Kitchen') will look for a localization file entry
with the key "Kitchen" and set the default to that value.
Parameters:
| Name | Type |
|---|---|
value |
string |
Returns: ModeSetting