Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
| Excerpt |
|---|
This class represents one result shown to the user when they search in a lookup or a list. |
Your search handlers are expected to return SearchResults bundled together in a SearchResult.Collection instance.
Example
| Code Block |
|---|
global with sharing class MySearchResults implements B25.SearchContext.SearchHandler {
global B25.SearchResult.Collection getResults(B25.SearchContext context) {
B25.SearchResult.Collection collection = new B25.SearchResult.Collection();
collection.addSearchResult(new B25.SearchResult('some-identifier', 'Hello World!'));
return collection;
}
} |
Methods
setSelectable
| Code Block |
|---|
B25.SearchResult setSelectable(Boolean selectable) |
Sets the ‘selectable’ property for this result. A result that is not selectable can’t be selected by the user. This is useful for displaying information to the user. The default value is true.
Return value: B25.SearchResult
Parameters:
Name | Type | Description |
|---|---|---|
selectable | Boolean | The value for the ‘selectable’ property. |
setPreventDefault
| Code Block |
|---|
B25.SearchResult setPreventDefault(Boolean preventDefault) |
Sets the ‘prevent default’ property for this result. A result that has ‘prevent default’ enabled, will not be added to the list when selected. This is useful for showing options which should trigger custom logic instead of adding a record. The default value is false.
Return value: B25.SearchResult
Parameters:
Name | Type | Description |
|---|---|---|
preventDefault | Boolean | The value for the ‘prevent default’ property. |
setMetaText
| Code Block |
|---|
B25.SearchResult setMetaText(String metaText) |
This method sets the meta text for the result.
Return value: B25.SearchResult
Parameters:
Name | Type | Description |
|---|---|---|
metaText | String | The text that you want to set. |
On this page | |
|---|---|
|