The SearchQuery type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| SearchQuery | DotNetNuke.Services.Search.Entities.SearchQuery |
Methods
| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) | |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods
| Name | Description | |
|---|---|---|
| ToJson |
Extension method on object that serializes the value to Json.
Note the type must be marked Serializable or include a DataContract attribute.
(Defined by JsonExtensionsWeb.) |
Properties
| Name | Description | |
|---|---|---|
| AllowLeadingWildcard |
Set this to true to allow search in word.
| |
| BeginModifiedTimeUtc |
Begin Date of the time when Content was last modified (in Utc). This field is optional.
| |
| BodySnippetLength |
Maximum length of highlighted title field in the results
| |
| CultureCode |
Culture Code associated with the content.
| |
| CustomKeywords |
Restrict search to specific Keywords. This field is optional. Lookup is done in the SearchDocument.Keywords collection.
| |
| CustomSortField |
Name of the custom sort field, works with SortFields.CustomNumericField or SortFields.CustomStringField option.
| |
| EndModifiedTimeUtc |
End Date of the time when Content was last modified (in Utc). This field is optional.
| |
| KeyWords |
Keywords to search for.
| |
| Locale |
Locale to restrict Search to. This field can be left empty for single language site
| |
| ModuleDefIds |
A collection of Module Def Ids that should be searched upon [Optional]. Match is performed only when a SearchTypeId for Module Search Crawler Id
| |
| ModuleId |
Module Id to restrict Search. Value > 0 is used only.
| |
| NumericKeys |
Restrict search to specific NumericKeys. This field is optional.
| |
| PageIndex |
Page Index for the result, e.g. pageIndex=1 and pageSize=10 indicates first 10 hits. Default value is 1
| |
| PageSize |
Page size of the search result. Default value is 10.
| |
| PortalIds |
A collection of Portal Ids of the Site to perform Search upon. This field must be specified or else Portal 0 will be searched by default.
| |
| RoleId |
Role Id to restrict Search. Value > 0 is used only.
| |
| SearchContext |
Context information such as the type of module that initiated the search can be stored here.
| |
| SearchTypeIds |
A collection of Search Type Ids that should be searched upon [Optional]
| |
| SortDirection |
Sort option of the search result. This field is optional.
| |
| SortField |
Sort option of the search result. This field is optional.
| |
| TabId |
Tab Id to restrict Search. Value > 0 is used only.
| |
| Tags |
Restrict search to specific tags. This field is optional.
| |
| TitleSnippetLength |
Maximum length of highlighted title field in the results
| |
| UniqueKey |
A key to uniquely identify a document in the Index
| |
| WildCardSearch |
Set this to true to perform perform WildCard Search.
|