SearchFields Class

Search fields collection and field constants

Inheritance Hierarchy

System.Object
  CMS.Search.SearchFields

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

Syntax

public class SearchFields : ISearchFields

The SearchFields type exposes the following members.

Constructors

	Name	Description
Public method	SearchFields()	Empty constructor
Public method	SearchFields(Boolean)	Constructor

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.
Protected method	AddInternal	Adds new field to collection. When field already exists, it will be updated (merged with existing one). When adding content field with it's value multiple times, the value is appended to existing content.
Public method	Get	Returns requested field. Null when field doesn't exist.
Protected method	InsertNewField	Inserts new search field into collection
Public method	PrepareContentValue	Prepares value to add to content field.
Protected method	UpdateExistingField	Updates existing search field in collection

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.)