GetOptions
Description
Gets the list of options to show in a specific section of the search UI.
Syntax
// searchPane points to instance of ISearchPane
const result = await searchPane.GetOptions(sectionID, useShortList);
Parameters
| Name | Optionality | Type | Description |
|---|---|---|---|
| sectionID | Required | string | The ID of the section the items of which should be returned. |
| useShortList | Required | boolean | Specifies if the list items should be returned in "short list" mode, including only about five items. |
Return type
| Type | Description |
|---|---|
Promise < { options?: any; more?: boolean; controlDisabled?: boolean; controlExpanded?: boolean; useFullList?: boolean; items?: any; } > | Receives an object with the properties "options" (array) and "more" (Boolean). Each option object in the array has properties such as "name" (string) and "selected" (Boolean). |
Exceptions
ArgumentError - When useShortList or sectionID is null or undefined.