SearchHelper Class

Provides the smart search methods.

Inheritance Hierarchy

System.Object
  CMS.Search.SearchHelper

Namespace: CMS.Search
Assembly: CMS.Search (in CMS.Search.dll) Version: 9.0.0

Syntax

public static class SearchHelper

The SearchHelper type exposes the following members.

Fields

	Name	Description
Public field Static member	CUSTOM_INDEX_DATA	Constant for custom index data.
Public field Static member	CUSTOM_SEARCH_INDEX	Constant for custom search index.
Public field Static member	DEFAULT_SEARCH_CONTENT_COLUMN	Constant for default class search content column.
Public field Static member	DEFAULT_SEARCH_CREATION_DATE_COLUMN	Constant for default class search creation date column.
Public field Static member	DEFAULT_SEARCH_TITLE_COLUMN	Constant for default class search title column.
Public field Static member	DOCUMENTS_CRAWLER_INDEX	Constant for custom search index.
Public field Static member	GENERALINDEX	General search index constant.
Public field Static member	INVARIANT_FIELD_VALUE	Invariant field value.
Public field Static member	MAX_INDEX_PATH	Max allowed length of path for place where indexes are stored. 260 is Windows limit, -1 for NULL, -16 for index file name, -1 for index name, -1 for slash
Public field Static member	ONLINEFORMINDEX	On-line forms search index constant.
Public field Static member	SIMPLE_ITEM_ID	Guid value of the simple search setting item.
Public field Static member	SynonymsWeight	Gets the weight (from interval 0 - 1.0f) which is given to synonyms if the synonym expansion is used. 1.0f means the synonyms are equally important as original words.

Properties

	Name	Description
Public property Static member	BasicSearchReplacer	Gets the regular expression for basic search replacement.
Public property Static member	CustomSearchPath	Custom search path.
Public property Static member	ExcludedFieldsFromConversion	Gets or sets the fields separated by semicolon, this field will be excluded from int/double conversion
Public property Static member	ImageContentReplacer	Gets the regular expression for image content tag.
Public property Static member	MaxAttachmentSize	Gets the maximum size of an attachment (in kB) which are processed with content extractors. 0 means unlimited size (default). If a positive number is set, attachments the size of which exceeds the value are not processed and their content is not indexed.
Public property Static member	MaxFieldLength	Maximal field length.
Public property Static member	MaxResults	Gets the value that is used for maximal number of records returned from search index.
Public property Static member	RemoveDiacriticsForIndexField	Gets the value that indicates whether diacritics should be removed for index field
Public property Static member	SearchContentXpathValue	XPath function to specify which web parts fields should be added to the search document content.
Public property Static member	Searchers	Collection of index Searchers. [key -> IndexSearcher]
Public property Static member	SearchOnlyWhenContentPresent	If true, performs the search only when the content part of the search expression is present.
Public property Static member	SearchPath	Search path. File system location where Smart Search stores the indexes.
Public property Static member	StoreContentField	Gets the value that indicates whether content field should be stored in the index
Public property Static member	SubsetAnalyzerWordRegex	Gets the regular expression for word splitting used in SubsetAnalyzer.

Methods

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