Class Query
Query object passed to the ISearchProvider
Inheritance
Inherited Members
Namespace: EPiServer.Shell.Search
Assembly: EPiServer.Shell.dll
Version: 10.10.4Syntax
public class Query
Constructors
Query(String)
Initializes a new instance of Query
Declaration
public Query(string searchQuery)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | searchQuery | Search query |
Query(String, IDictionary<String, Object>)
Initializes a new instance of Query
Declaration
public Query(string searchQuery, IDictionary<string, object> parameters)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | searchQuery | Search query |
| System.Collections.Generic.IDictionary<System.String, System.Object> | parameters | A collection of query parameters |
Query(String, Int32)
Initializes a new instance of Query
Declaration
public Query(string searchQuery, int maxResults)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | searchQuery | Search query |
| System.Int32 | maxResults | Maximum number of hits that should be returned |
Query(String, Int32, IDictionary<String, Object>)
Initializes a new instance of Query
Declaration
public Query(string searchQuery, int maxResults, IDictionary<string, object> parameters)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | searchQuery | Search query |
| System.Int32 | maxResults | Maximum number of hits that should be returned |
| System.Collections.Generic.IDictionary<System.String, System.Object> | parameters | A collection of query parameters |
Properties
FilterOnCulture
Gets or sets a value indicating whether to filter on culture.
Declaration
public bool FilterOnCulture { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
MaxResults
Gets/Sets the maximum number of hits that should be returned
Declaration
public int MaxResults { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
Parameters
Gets a collection of query parameters to be used by the search provider.
Declaration
public IDictionary<string, object> Parameters { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IDictionary<System.String, System.Object> |
SearchQuery
Gets/Sets the search query
Declaration
public string SearchQuery { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
SearchRoots
Gets or sets the roots used when searching.
Declaration
public IEnumerable<string> SearchRoots { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> |