ISearchable Interface

Interface for search.

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

Syntax

public interface ISearchable

The ISearchable type exposes the following members.

Properties

	Name	Description
Public property	SearchType	Gets or sets the search object type.

Methods

	Name	Description
Public method	GetSearchDocument	Returns iDocument with dependence on current object type and index.
Public method	GetSearchFields	Returns search fields collection. When existing collection is passed as argument, fields will be added to that collection. When collection is not passed, new collection will be created and return. Collection will contain field values only when collection with StoreValues property set to true is passed to the method. When method creates new collection, it is created with StoreValues property set to false.
Public method	GetSearchID	Gets the search item unique id.
Public method	GetSearchImageUrl	Returns URL to current search result item.
Public method	GetValue	Returns value of column.
Public method	SetValue	Sets value of column.

Extension Methods

	Name	Description
Public Extension Method	AddContentField	Process search settings of DataClass field and inserts required search field into search fields collection when field is marked as content field. (Defined by SearchableExtensions.)
Public Extension Method	AddSearchableField	Process search settings of DataClass field and inserts required search field into search fields collection when field is searchable. (Defined by SearchableExtensions.)