Search¶
Search over the items in the list.
When using target binding, only the property names available in the target EntitySet are valid search keys. By default, these keys are generated from the searchable parameters of items with values of Binding or TargetPath. Rules results or other complex mappings (e.g. Formatters or Default Value Binding) are not considered.
When assigning a rule to a property of Search, the rule will be passed an instance of the following proxy class as an argument:
Search Properties¶
| Property | Type | Required |
|---|---|---|
| AdditionalProperties | string[] |
No |
| BarcodeScanner | boolean |
No |
| Delay | integer |
No |
| Enabled | boolean |
No |
| Icons | object |
No |
| MinimumCharacterThreshold | number |
No |
| OnScanPress | Rule | No |
| Placeholder | string |
No |
AdditionalProperties¶
Additional properties of the EntitySet that will be added to the search keys, in addition to the default ones. Strings not available in the EntitySet, and the number-typed properties if NumberSearch is not enabled, will be ignored. Not applicable when using fixed collection.
BarcodeScanner¶
Enables the use of a barcode scanner in search.
- type:
boolean
Delay¶
Delay represents the number of milliseconds to delay. As a user is adding or deleting characters in the search text entry field, it will be used to delay the execution of the search.
If Delay is set to zero or not defined then no delay will be used and the search will be executed as soon as the user enters the minimum character count.
If Delay is greater than zero, then the delay will be reset each time the user enters or deletes a character under the minimum character count.
- type:
integer
Enabled¶
Enables search on the ListPicker.
- type:
boolean
Icons¶
Custom icons for the Search bar. Not supported on iOS.
- type:
objectwith following properties.
| Property | Type | Required | Default |
|---|---|---|---|
Search |
Image | No | |
Clear |
Image | No | |
Barcode |
Image | No | |
Styles |
object | No |
Search¶
Custom icon for the Search button.
Clear¶
Custom icon for the Clear button.
Barcode¶
Custom icon for the barcode scanner button.
Styles¶
Style classes to apply to the search bar icons.
- type:
objectwith following properties.
| Property | Type | Required | Default |
|---|---|---|---|
| Search | string | No | |
| Clear | string | No | |
| Barcode | string | No |
Search¶
The string value is a style class name for the search icon.
- Image style class
Clear¶
The string value is a style class name for the clear icon.
- Image style class
Barcode¶
The string value is a style class name for the barcode scanner icon.
- Image style class
MinimumCharacterThreshold¶
The MinimumCharacterThreshold is limited to a non-negative integer number and represents the minimum number of characters required before a search is executed.
If the MinimumCharacterThreshold is zero then every character will be searched.
If MinimumCharacterThreshold is greater than 0, a minimum of Y characters will be accepted in the search field before executing the search.
- type:
number
OnScanPress¶
This event will be triggered when the barcode scan button is pressed. It allows app to provide its own custom scanning capability via rule. When the rule is executed, the default barcode scan using on-device camera will not be triggered and the rule is expected to return a promise. If the promise is resolved with a string result, the search will be carried out using the result string. If the promise is rejected, then it will fallback to use the default barcode scan using on-device camera.
- type: Rule
- default:
""
Placeholder¶
Placeholder text for the search field when the field is empty.
- type:
string