SearchParameters Class

Structure to define the search parameters used for search.

Inheritance Hierarchy

System.Object
  CMS.Search.SearchParameters

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

Syntax

public class SearchParameters

The SearchParameters type exposes the following members.

Constructors

	Name	Description
Public method	SearchParameters

Properties

	Name	Description
Public property	AttachmentOrderBy	Order by for attachments search
Public property	AttachmentWhere	Where condition for attachments search
Public property	BlockFieldOnlySearch	If true, performs the search only when the content part of the search expression is present.
Public property	CheckPermissions	Indicates whether check permissions
Public property	ClassNames	Class names separated by semicolon.
Public property	CombineWithDefaultCulture	Whether combine with default culture
Public property	CurrentCulture	Current culture
Public property	DefaultCulture	Default culture
Public property	DisplayResults	Number of results which should be displayed
Public property	MaxScore	Returns the maximum score value encountered within the search hits (among the NumberOfResults results).
Public property	NumberOfProcessedResults	Number of processed results due to performance optimization
Public property	NumberOfResults	Number of results for the search query.
Public property	Path	Path
Public property	SearchAllCultures	Returns true, if the search parameters search for all cultures
Public property	SearchFor	Search query
Public property	SearchInAttachments	Indicates whether search in attachments
Public property	SearchIndexes	List of search index names to search in, separated by semicolon
Public property	SearchSort	Search sort expression
Public property	StartingPosition	Starting position in search results (paging)
Public property	User	User info

Methods

	Name	Description
Public method Static member	PrepareForPages(String, IEnumerable<String>, Int32, Int32, IUserInfo, Boolean)	Creates a new instance of the SearchParameters class for a page search for given searchText across indexes specified in searchIndexNames. The user parameter limits search result when performing permission checks in result filtering. Retrieves the result for the first page for invalid page numbers.
Public method Static member	PrepareForPages(SearchPattern, IEnumerable<String>, Int32, Int32, IUserInfo, Boolean)	Creates a new instance of the SearchParameters class for a page search for given searchPattern across indexes specified in searchIndexNames. The user parameter limits search result when performing permission checks in result filtering. Retrieves the result for the first page for invalid page numbers.
Public method Static member	PrepareForPages(String, IEnumerable<String>, Int32, Int32, IUserInfo, String, Boolean)	Creates a new instance of the SearchParameters class for a page search for given searchText across indexes specified in searchIndexNames. The user parameter limits search result when performing permission checks in result filtering. Retrieves the result for the first page for invalid page numbers.
Public method Static member	PrepareForPages(SearchPattern, IEnumerable<String>, Int32, Int32, IUserInfo, String, Boolean)	Creates a new instance of the SearchParameters class for a page search for given searchPattern across indexes specified in searchIndexNames. The user parameter limits search result when performing permission checks in result filtering. Retrieves the result for the first page for invalid page numbers.