SearchField Class

Represents search field

Inheritance Hierarchy

System.Object
  CMS.Search.SearchField

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

Syntax

public class SearchField : ISearchField

The SearchField type exposes the following members.

Constructors

	Name	Description
Public method	SearchField

Methods

	Name	Description
Public method	Init	Initializes object values.
Public method	ToString	Converts this piece of data into a string. (Overrides Object.ToString().)

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	Analyzer	Explicit analyzer to process search field's value. When null default analyzer is used based on search index configuration.
Public property	FieldName	Name of the field.
Public property	InsertDirectly	When field is marked to be insert directly, it will not be processed before it's inserted into search document. Will not be passed to SearchHelper.AddGeneralField method.
Public property	Searchable	True when field is marked as searchable.
Public property	Tokenized	True when field is tokenizable (analyzer is used to process it's value).
Public property	Value	Field value. May be null when field is not initialized with it's value.