Skip to content

SearchOptions

Options for generating the OData search query. Not applicable to ListPicker using fixed collection

SearchOptions Properties

Property Type Required Default
CaseSensitive boolean No false
NumberSearch object No
UseSearchOverFilter object No

CaseSensitive

Determines the case sensitivity of the search. This applies to Offline OData only. For Online OData, case sensitivity depends on the backend service used.

  • type: boolean
  • default: false

NumberSearch

Options for number-typed properties. This applies to both Offline and Online OData. However, using Online OData, enabling NumberSearch without backend support or using an unsupported ConversionMethod will cause the entire search process to fail if there are number-typed properties in the search keys.

  • type: object with following properties.
Property Type Required Default
Enabled boolean No false
ConversionMethod string No NoConversion

Enabled

Determines whether number-typed properties should be included during a search.

ConversionMethod

The conversion method to use on number-typed properties during a search, if NumberSearch is enabled. This applies to Online OData only.

The value of this property must be one of the known values listed below.

Value Description
NoConversion No conversion.
UseCast Conversion into Edm.String by calling cast.
UseConcat Conversion into Edm.String by calling concat with an empty string.

UseSearchOverFilter

Options for UseSearchOverFilter properties. This applies to both Offline and Online OData.

  • type: object with following properties.
Property Type Required Default
Enabled boolean No

Enabled

Determines whether to use Built-in Search - $search query option.