ISearch interface
Namespace: NextDesign.Core
Description
Provides access to search services.
The current version of the application allows only one search processing process.
Therefore, it is an error to call BeginSearch while IsSearching returns True.
Affiliation area
Name | Description |
---|---|
Search/error/output | A group of APIs to access error information, search results, and the output window. |
Property
Name | Description |
---|---|
IsSearchCanceled | Checks if a cancellation request has been issued for the current search. Returns True if cancellation is requested. |
IsSearching | Checks if searching is in progress. Returns True if the search processing process is running. |
Name | Search name |
SearchTargets | Collection of search target models |
ShowTotalCount | Whether to display the stacked value of search results |
Type | Search type |
Method
Name | Description |
---|---|
AddSearchResult(IModel,string,string) | Register the search result. If the search target is a model in particular, you can use this interface to add field information that hits the search conditions. |
AddSearchResult(object,string) | Register the search result. If information other than the model is handled as search results, it can be registered using this method. |
AddSearchTarget | Add a search target. Search target information is displayed in the search result window, editor, navigator, etc. |
BeginSearch | Requests to start a search. |
CancelSearch | Requests to cancel the search. Registration of search results will be ignored after cancellation is requested. |
ClearSearchResult | Clears the current search results. |
ClearSearchTarget | Clears the search target. |
EndSearch | Requests end of search. Finishes the currently running search process and commits the search results. Confirmed search results will be available in the search results list. |