| SearchHelper Methods |
The SearchHelper type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AddGeneralField |
Adds a general field do the search document.
|
| AddObjectDataToDocument |
Adds object data to iDocument, data for content field prepares and returns.
|
| CleanSearchSettings |
Cleans the search settings from settings which does not correspond to any fields in the class and returns the filtered definition.
|
| CreateDocument |
Creates search document based on given parameters
|
| CreateEmptyDocument |
Creates empty search document.
|
| CreateRebuildTask |
Creates rebuild task if search settings are not empty, for user index is task created always.
|
| CreateSearchSettings(String, Boolean, Boolean, Boolean, String) |
Creates new SearchSettingsInfo with given parameters.
|
| CreateSearchSettings(String, Boolean, Boolean, Boolean, String, SearchSettingsInfo, Boolean) |
Creates new SearchSettingsInfo with given parameters. Returns whether the parameters changed from the original search settings.
|
| Delete(String, ICollection, SearchIndexInfo) |
Remove document(s) with dependence on field name and field value collection for specified index.
|
| Delete(String, String, SearchIndexInfo) |
Remove document(s) with dependence on field name and field value for specified index.
|
| FilterResults |
Filters the search results, returns number of resulting items
|
| FinishRebuild |
Finishes the rebuild of the given index by marking it as updated
|
| GetBinaryDataSearchContent |
Extracts the search information from the info. Returns null by default. Should be overridden by specific info.
|
| GetClassSearchFields(Int32) |
Returns list of all fields of the given class (along with their types) which should be included in the search.
|
| GetClassSearchFields(String) |
Returns list of all fields of the given class (along with their types) which should be included in the search.
|
| GetClassSearchFields(DataClassInfo) |
Returns list of all fields of the given class (along with their types) which should be included in the search.
|
| GetCustomSearchIndex |
Returns ICusromSearchIndex for specified index info.
|
| GetDefaultSearchSettings(String) |
Returns the default search settings of the class.
|
| GetDefaultSearchSettings(DataClassInfo) |
Returns the default search settings of the class.
|
| GetResultsToProcess |
Processes the results from the given range matching the required type
|
| GetResultTypes |
Gets the list of all types present in the given results
|
| GetSearchFieldDefaultValue |
Gets value which should be preselected for given column.
|
| GetStopWordsFileInfo |
Returns FileInfo object of stop words file for the given path
|
| Highlight |
Highlight input text with dependence on current search key words.
|
| InitDocument |
Initializes search document.
|
| InvalidateSearcher |
Invalidates searcher for the given index.
|
| IsClassSearchEnabled |
Returns true if given class allows search.
|
| IsSearchAllowedExtension |
Check if file extension is allowed for indexing such attachment in search index.
|
| IsSearchTaskCreationAllowed |
Returns true if the search task for given node should be created.
Returns true if
- search is allowed on general level AND
- search is allowed for class of the object
|
| LoadCustomAnalyzerTAnalyzerType |
Returns analyzer object for specified analyzer name.
|
| Optimize |
Optimize specified index.
|
| PartialRebuild |
Rebuild part of the index with dependence on type and values.
|
| PrepareContentValue |
Prepares value to add to content field.
|
| Rebuild |
Rebuild specified index.
|
| Search |
Returns dataset with search results, if search is used for non-document index, path and class name values are ignored (can be null).
|
| SearchEnabledForClass |
Returns true if search is enabled for a given class (document type). Returns false if class not found.
|
| SearchFieldChanged |
Returns true if any field included in the search changed (checks fields defined in Class Search Settings).
|
| SetDefaultClassSearchColumns |
Sets default class search columns.
|
| Update |
Insert or update document for specified index.
|
See Also