SearchResultItem Class

Represents one search result.

Inheritance Hierarchy

System.Object
  CMS.Search.SearchResultItem

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

Syntax

public sealed class SearchResultItem : IDataContainer, 
	ISimpleDataContainer

The SearchResultItem type exposes the following members.

Constructors

	Name	Description
Public method	SearchResultItem	Initializes a new instance of the SearchResultItem class with parent search result set to result.

Properties

	Name	Description
Public property	AbsScore	Gets or sets the absolute score of a result item.
Public property	Content	Gets the content of the search item. Contains data from the field configured as 'Content field' in search index configuration.
Public property	Created	Gets the date associated with search item. Contains data from the field configured as 'Date field' in search index configuration. If no date information found, contains MinValue.
Public property	Data	Info object to get type specific data.
Public property	DocumentExtensions	Gets or sets the document extensions of a result item.
Public property	Id	Gets or sets the identifier of a result item.
Public property	Image	Gets or sets the image of a result item.
Public property	Index	Gets or sets the index name of a result item.
Public property	MaxScore	Gets or sets the maximum score of a result item.
Public property	Position	Gets or sets the position of a result item.
Public property	Result	Gets SearchResult a search item belongs to.
Public property	ResultData	Gets or sets the raw result data.
Public property	Score	Gets or sets the score of a result item.
Public property	SearchDocument	Gets or sets the source search document of this result item.
Public property	Title	Gets the title of the search item. Contains data from the field configured as 'Title field' in search index configuration.
Public property	Type	Gets the type of an object where the search item was found in (i.e. cms.document, cms.customtable).

Methods

	Name	Description
Public method	GetImageUrl	Returns the relative image URL associated with search item. The image URL is based on data from the field configured as 'Image field' (Image) in search index configuration.
Public method	GetSearchValue	Returns column value for current search result item. The value is obtained from ResultData, if such column is present, or SearchDocument.

Extension Methods

	Name	Description
Public Extension Method	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, Boolean)	Overloaded. Writes XML representation of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)
Public Extension Method	ToXML(String, Boolean)	Overloaded. Returns XML representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, List<String>, Boolean)	Overloaded. Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)