ISearchFields Interface

Search fields collection and field constants

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

Syntax

public interface ISearchFields

The ISearchFields type exposes the following members.

Properties

	Name	Description
Public property	Items	Search fields
Public property	StoreValues	Indicates if field values will be retrieved and stored in collection.

Methods

	Name	Description
Public method	Add	Adds a new field to the collection. If the field already exists, it is updated (merged with existing one). When adding a content field and its value multiple times, the value is appended to the existing content field.
Public method	Get	Returns requested field. Null when field doesn't exist.
Public method	PrepareContentValue	Prepares value to add to content field.

Extension Methods

	Name	Description
Public Extension Method	AddContentField	Appends search field value into designated content field if IsContentField(ISearchIndexInfo, SearchSettingsInfo) is true. (Defined by SearchFieldsExtensions.)
Public Extension Method	AddIndexField	Inserts index field into search fields collection if IsIndexField(ISearchIndexInfo, SearchSettingsInfo) is true. (Defined by SearchFieldsExtensions.)
Public Extension Method	AddSystemFields	Adds system search fields to searchFields. (Defined by SearchFieldsExtensions.)
Public Extension Method	AddToContentField	Appends data to CONTENT field. Field is created if it's not already present. (Defined by SearchFieldsExtensions.)
Public Extension Method	EnsureContentField	Ensures CONTENT field in collection. Field is created if it's not already present. (Defined by SearchFieldsExtensions.)