Click or drag to resize
SearchResultItem Class
Represents one search result.
Inheritance Hierarchy
SystemObject
  CMS.SearchSearchResultItem

Namespace: CMS.Search
Assembly: CMS.Search (in CMS.Search.dll) Version: 13.0.131
Syntax
C#
public sealed class SearchResultItem : IDataContainer, 
	ISimpleDataContainer

The SearchResultItem type exposes the following members.

Constructors
  NameDescription
Public methodSearchResultItem
Initializes a new instance of the SearchResultItem class with parent search result set to result.
Top
Properties
  NameDescription
Public propertyAbsScore
Gets or sets the absolute score of a result item.
Public propertyContent
Gets the content of the search item. Contains data from the field configured as 'Content field' in search index configuration.
Public propertyCreated
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 propertyData
Info object to get type specific data.
Public propertyDocumentExtensions
Gets or sets the document extensions of a result item.
Public propertyId
Gets or sets the identifier of a result item.
Public propertyImage
Gets or sets the image of a result item.
Public propertyIndex
Gets or sets the index name of a result item.
Public propertyMaxScore
Gets or sets the maximum score of a result item.
Public propertyPosition
Gets or sets the position of a result item.
Public propertyResult
Gets SearchResult a search item belongs to.
Public propertyResultData
Gets or sets the raw result data.
Public propertyScore
Gets or sets the score of a result item.
Public propertySearchDocument
Gets or sets the source search document of this result item.
Public propertyTitle
Gets the title of the search item. Contains data from the field configured as 'Title field' in search index configuration.
Public propertyType
Gets the type of an object where the search item was found in (i.e. cms.document, cms.customtable).
Top
Methods
  NameDescription
Public methodGetImageUrl
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 methodGetSearchValue
Returns column value for current search result item. The value is obtained from ResultData, if such column is present, or SearchDocument.
Top
Extension Methods
  NameDescription
Public Extension MethodCheckRequiredColumns
Returns true if given list of columns do not have null values in the object
(Defined by DataExtensions.)
Public Extension MethodToJSON
Returns JSON representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Public Extension MethodToXML(XmlWriter, Boolean)Overloaded.
Writes XML representation of current instance of IDataContainer to provided XmlWriter.
(Defined by DataExtensions.)
Public Extension MethodToXML(String, Boolean)Overloaded.
Returns XML representation of current instance of IDataContainer.
(Defined by DataExtensions.)
Public Extension MethodToXML(XmlWriter, ListString, Boolean)Overloaded.
Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter.
(Defined by DataExtensions.)
Top
See Also