Skip to main content

SetOptionState

Description​

Sets the state of the specified option.

Syntax​

// searchPane points to instance of ISearchPane
await searchPane.SetOptionState(sectionID, optionID, state);

Parameters​

NameOptionalityTypeDescription
sectionIDRequiredstringThe ID of the section.
optionIDRequiredstringThe ID of the option to select/deselect.
Note that this is the ID of the option (as specified in the "id" property of the option), and NOT the array index of the option.
stateRequiredbooleanSpecifies the new state of the option (selected/deselected).

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When sectionID, optionID, or state is null or undefined.