Click or drag to resize
SearchParameters Class
Structure to define the search parameters used for search.
Inheritance Hierarchy
SystemObject
  CMS.SearchSearchParameters

Namespace: CMS.Search
Assembly: CMS.Search (in CMS.Search.dll) Version: 13.0.131
Syntax
C#
public class SearchParameters

The SearchParameters type exposes the following members.

Constructors
  NameDescription
Public methodSearchParameters
Top
Properties
  NameDescription
Public propertyAttachmentOrderBy
Order by for attachments search
Public propertyAttachmentWhere
Where condition for attachments search
Public propertyBlockFieldOnlySearch
If true, performs the search only when the content part of the search expression is present.
Public propertyCheckPermissions
Indicates whether check permissions
Public propertyClassNames
Class names separated by semicolon.
Public propertyCombineWithDefaultCulture
Whether combine with default culture
Public propertyCurrentCulture
Current culture
Public propertyDefaultCulture
Default culture
Public propertyDisplayResults
Number of results which should be displayed
Public propertyMaxScore
Returns the maximum score value encountered within the search hits (among the NumberOfResults results).
Public propertyNumberOfProcessedResults
Number of processed results due to performance optimization
Public propertyNumberOfResults
Number of results for the search query.
Public propertyPath
Path
Public propertySearchAllCultures
Returns true, if the search parameters search for all cultures
Public propertySearchFor
Search query
Public propertySearchInAttachments
Indicates whether search in attachments
Public propertySearchIndexes
List of search index names to search in, separated by semicolon
Public propertySearchSort
Search sort expression
Public propertyStartingPosition
Starting position in search results (paging)
Public propertyUser
User info
Top
Methods
  NameDescription
Public methodStatic memberPrepareForPages(String, IEnumerableString, 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 methodStatic memberPrepareForPages(SearchPattern, IEnumerableString, 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 methodStatic memberPrepareForPages(String, IEnumerableString, 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 methodStatic memberPrepareForPages(SearchPattern, IEnumerableString, 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.

Top
See Also