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: 8.2.23
Syntax
C#
public class SearchParameters

The SearchParameters type exposes the following members.

Constructors
  NameDescription
Public methodSearchParameters
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
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 propertyClassNames
Class names
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 propertyCheckPermissions
Indicates whether check permissions
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 which (for pager settings)
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
See Also