SearchFieldsHelper Class

Contains helper methods for index fields.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.SearchFieldsHelper

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 13.0.131

Syntax

public class SearchFieldsHelper

The SearchFieldsHelper type exposes the following members.

Fields

	Name	Description
Public field	IncludeContentField	An event raised upon IsContentField(ISearchIndexInfo, SearchSettingsInfo) execution. Based on the Result the field is added to content fields. By default, all fields having flag named CONTENT set to true are considered content fields.
Public field	IncludeIndexField	An event raised upon IsIndexField(ISearchIndexInfo, SearchSettingsInfo) execution. Based on the Result the field is added to index fields. By default, all fields having flag named SEARCHABLE set to true are added.
Public field	IncludeTriggerField	An event raised upon IsTriggerField(SearchSettingsInfo) execution. Based on the Result the change of this field triggers index update. By default, all fields having flag named INDEX_UPDATE_TRIGGER triggers index update. For backward compatibility if the flag is not present fallback is used and returns true if field is Content or Searchable field.

Properties

	Name	Description
Public property Static member	Instance	Gets the SearchFieldsHelper instance.

Methods

	Name	Description
Public method	IsContentField	Returns true if value of field represented by searchSettings is to be included in a designated content column in given index.
Public method	IsIndexField	Returns true if field represented by searchSettings is to be included in given index.
Public method	IsTriggerField	Returns true if value of field represented by searchSettings triggers index update upon change.