SearchDocument Class

Represents collection of field values for indexing.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.SearchDocument

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

Syntax

public class SearchDocument

The SearchDocument type exposes the following members.

Constructors

	Name	Description
Public method	SearchDocument

Fields

	Name	Description
Public field Static member	DOCUMENT_EXCLUDED_FROM_SEARCH_FIELD	Name of the field in the search document whose value defines if the search document should be included in an index.

Properties

	Name	Description
Public property	Names	Gets enumeration of field names contained in the search document.

Methods

	Name	Description
Public method	Add(String, Object)	Adds new field data to the search document.
Public method	Add(String, Object, Boolean, Boolean)	Adds new field data to the search document.
Public method	Contains	Returns true if document contains column name. false otherwise.
Public method	GetStore	Gets store flag of a field.
Public method	GetTokenize	Gets tokenize flag of a field.
Public method	GetValue	Gets value of a field.
Public method	Remove	Removes the field with specified name from the search document.

Extension Methods

	Name	Description
Public Extension Method	AddSearchField	Adds given search field to search document. (Defined by SearchDocumentExtensions.)
Public Extension Method	Initialize(SearchDocumentParameters)	Overloaded. Initializes search document from parameters. (Defined by SearchDocumentExtensions.)
Public Extension Method	Initialize(ISearchIndexInfo, String, String, DateTime)	Overloaded. Initializes search document from given parameters. (Defined by SearchDocumentExtensions.)