SearchFields Class

Search fields collection and field constatns

Inheritance Hierarchy

System.Object
  CMS.Search.SearchFields

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

Syntax

public class SearchFields : ISearchFields

The SearchFields type exposes the following members.

Constructors

	Name	Description
Public method	SearchFields()	Empty contructor
Public method	SearchFields(Boolean)	Contructor

Methods

	Name	Description
Protected method	Add(ISearchField)	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	Add(String, Boolean, Boolean, Func<Object>, Boolean, Nullable<SearchAnalyzerTypeEnum>)	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	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

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