Query properties
The Query type exposes the following members.
Properties
Name | Description | |
---|---|---|
AuthenticationType | Gets or sets the authentication type for the query. | |
BlockDedupeMode | Sets the de-duplication mode for result block ranking. | |
BypassResultTypes | Gets or sets a Boolean value that indicates whether the ResultTypes obtained from the search results should be used or overridden. | |
ClientType | Specifies the name of the client which issued the query. | |
Culture | Gets or sets the locale for the query. | |
Culture_Client | Gets or sets an integer that represents the CultureInfo. | |
DesiredSnippetLength | Gets or sets the preferred summary length. | |
DirectServiceEndpointUri | Gets or sets the address the Search service application proxy should use instead of the URL that was specified in the constructor for the Search service application proxy. | |
EnableInterleaving | A Boolean value that specifies whether the ResultTable objects in the ResultTableCollection produced by running this query should be interleaved. The default value is true. | |
EnableNicknames | Gets or sets a Boolean value that specifies whether the exact terms in the search query are used to find matches, or if nicknames are used as well. | |
EnableOrderingHitHighlightedProperty | A Boolean value that specifies whether the hit highlighted properties should be ordered by hit highlighted terms. | |
EnablePhonetic | Gets or sets a Boolean value that specifies whether the phonetic forms of the query terms are used to find matches. | |
EnableQueryRules | A Boolean value that specifies whether Query Rules are enabled for this query. The default value is true. | |
EnableStemming | Gets or sets a Boolean value that specifies whether stemming is enabled. | |
GenerateBlockRankLog | A Boolean value that specifies whether to return information on the rank log for the result block via the BlockRankLog property of the interleaved result table. | |
HighlightedSentenceCount | Gets or sets the number of sentences to include in the hit highlighted summary. The value should be between 1 and 10. | |
Hint | Gets or sets the suggested query processor behavior for the query. No hint is provided by default. | |
HitHighlightedMultivaluePropertyLimit | Represents a multi-valued hit highlighted property limit. | |
HitHighlightedProperties | Gets the collection of hit highlighted properties for the query. | |
HitHighlightedProperties_Client | Returns a collection of hit highlighted properties. | |
IgnoreAllNoiseQuery | Gets or sets a Boolean value that specifies whether the search query should run if the query text contains only noise words. | |
IgnoreSafeQueryPropertiesTemplateUrl | Gets or sets a flag that indicates whether the SafeQueryPropertiesTemplateUrl property should be ignored. | |
ImpressionID | Gets or sets the identifier (ID) of the page impression. | |
KeywordInclusion | Gets or sets a value that specifies whether the query returns results that contain all or any of the specified search terms. | |
MaxSnippetLength | Specifies the maximum length of the result summary. | |
PagingCookie | Represents the client side cookie used for paging through the search results. | |
PartitionId | Specifies the unique identifier (ID) of the index partition to use for this search query. | |
PersonalizationData | Gets or sets the user personalization data for the current user who submitted the search query. | |
PersonalizationData_Client | Gets the user personalization data and sets the unique identifier (ID) for the current user who submitted the search query. | |
Priority | Gets or sets the priority of the query. | |
ProcessBestBets | A Boolean value that determines whether Best Bets are enabled. | |
ProcessPersonalFavorites | A Boolean value that determines whether personal favorites data is processed. | |
Properties | Gets the query property bag. | |
QueryInfo | Get the query log data for a single click-through for a search query. | |
QueryTag | Gets or sets any custom tags to be used to identify the query. Multiple tags are separated by semicolons. | |
QueryTemplate | Specifies the query template that is used at run time to transform the query based on user input. | |
QueryTemplateParameters | Represents the parameters in the query template. | |
QueryText | Gets or sets the text for the search query. | |
RankingModelId | Gets or sets the identifier (ID) of the ranking model to use for the query. | |
ResultsProvider | Gets or sets the search provider to use for the search query | |
ResultsUrl | Gets or sets the results page URL of the query. | |
ResultTypes | Obsolete. Gets or sets a value that specifies the search result type. | |
RowLimit | Gets or sets the maximum number of rows returned in the search results, at the index specified by the StartRow() property. | |
RowsPerPage | Gets or sets the number of search results to return per page. | |
SafeQueryPropertiesTemplateUrl | Specifies the location of the QueryProperties template. This property must be specified when issuing a query by a user who does not have UseRemoteAPIs() permission enabled. If the query will not run without UseRemoteAPIs() permission enabled, you can set the IgnoreSafeQueryPropertiesTemplateUrl property to true instead. | |
ShowPeopleNameSuggestions | Specifies whether to generate name suggestions. | |
Site | Gets the site from where the search query is run from. | |
SiteContext | Gets or sets the site URL for the search query. | |
SourceId | Specifies the identifier (ID) of the result source to be used to run the query. | |
StartRow | Gets or sets first row included in the search results. | |
SummaryLength | Gets or sets the length of the search result summary. | |
Timeout | Gets or sets the amount of time, in milliseconds, before the query request times out. | |
TotalRowsExactMinimum | Used by SearchPagingWebPart to determine the minimum value required for rendering page links. | |
TrimDuplicates | Gets or sets a Boolean value that specifies whether duplicate items should be removed from the search results. | |
UILanguage | Specifies the UI language. | |
UrlZone | Gets the originating URL zone for the query request. |
Top