KeywordQuery properties
The KeywordQuery type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AuthenticationType | Gets or sets the authentication type for the query. (Inherited from Query.) |
|
BlockDedupeMode | Sets the de-duplication mode for result block ranking. (Inherited from Query.) |
|
BypassResultTypes | Gets or sets a Boolean value that indicates whether the ResultTypes obtained from the search results should be used or overridden. (Inherited from Query.) |
|
ClientType | Specifies the name of the client which issued the query. (Inherited from Query.) |
|
CollapseSpecification | Gets or sets criteria to use for collapsing search results. |
|
Culture | Gets or sets the locale for the query. (Inherited from Query.) |
|
Culture_Client | Gets or sets an integer that represents the CultureInfo. (Inherited from Query.) |
|
CustomRefinementIntervals | Gets or sets the refinement intervals that should be imposed on the refinements. |
|
DesiredSnippetLength | Gets or sets the preferred summary length. (Inherited from Query.) |
|
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. (Inherited from Query.) |
|
EnableFQL | Gets or sets a Boolean value that specifies whether the query string is using the FAST Query Language (FQL) syntax. For details, see FAST Query Language (FQL) syntax reference. |
|
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. (Inherited from Query.) |
|
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. (Inherited from Query.) |
|
EnableOrderingHitHighlightedProperty | A Boolean value that specifies whether the hit highlighted properties should be ordered by hit highlighted terms. (Inherited from Query.) |
|
EnablePhonetic | Gets or sets a Boolean value that specifies whether the phonetic forms of the query terms are used to find matches. (Inherited from Query.) |
|
EnableQueryRules | A Boolean value that specifies whether Query Rules are enabled for this query. The default value is true. (Inherited from Query.) |
|
EnableSorting | A Boolean value that indicates whether the search results should be sorted. |
|
EnableSpellcheck | Specifies how to apply spell correction of the query terms when processing the query.. |
|
EnableStemming | Gets or sets a Boolean value that specifies whether stemming is enabled. (Inherited from Query.) |
|
EnableUrlSmashing | Applies to: Microsoft SharePoint Server 2010 search Gets or sets a Boolean value that specifies whether URL smashing 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. (Inherited from Query.) |
|
GenerationId | Specifies the index generation from which the search results should be retrieved. |
|
HiddenConstraints | Gets or sets the keyword query’s hidden constraints. |
|
HighlightedSentenceCount | Gets or sets the number of sentences to include in the hit highlighted summary. The value should be between 1 and 10. (Inherited from Query.) |
|
Hint | Gets or sets the suggested query processor behavior for the query. No hint is provided by default. (Inherited from Query.) |
|
HitHighlightedMultivaluePropertyLimit | Represents a multi-valued hit highlighted property limit. (Inherited from Query.) |
|
HitHighlightedProperties | Gets the collection of hit highlighted properties for the query. (Inherited from Query.) |
|
HitHighlightedProperties_Client | Returns a collection of hit highlighted properties. (Inherited from Query.) |
|
IgnoreAllNoiseQuery | Gets or sets a Boolean value that specifies whether the search query should run if the query text contains only noise words. (Inherited from Query.) |
|
IgnoreSafeQueryPropertiesTemplateUrl | Gets or sets a flag that indicates whether the SafeQueryPropertiesTemplateUrl property should be ignored. (Inherited from Query.) |
|
ImpressionID | Gets or sets the identifier (ID) of the page impression. (Inherited from Query.) |
|
IsCachable | A Boolean value that indicates whether ACLs are cached during security trimming. |
|
KeywordInclusion | Gets or sets a value that specifies whether the query returns results that contain all or any of the specified search terms. (Inherited from Query.) |
|
KeywordQueryProperties_Client | The client-callable equivalent of KeywordQueryProperties. |
|
MaxShallowRefinementHits | Obsolete. |
|
MaxSnippetLength | Specifies the maximum length of the result summary. (Inherited from Query.) |
|
MaxSummaryLength | Gets or sets the maximum length of the search result summary. |
|
MaxUrlLength | Gets or sets the maximum length of the search result URL. |
|
PagingCookie | Represents the client side cookie used for paging through the search results. (Inherited from Query.) |
|
PartitionId | Specifies the unique identifier (ID) of the index partition to use for this search query. (Inherited from Query.) |
|
PersonalizationData | Gets or sets the user personalization data for the current user who submitted the search query. (Inherited from Query.) |
|
PersonalizationData_Client | Gets the user personalization data and sets the unique identifier (ID) for the current user who submitted the search query. (Inherited from Query.) |
|
Priority | Gets or sets the priority of the query. (Inherited from Query.) |
|
ProcessBestBets | A Boolean value that determines whether Best Bets are enabled. (Inherited from Query.) |
|
ProcessPersonalFavorites | A Boolean value that determines whether personal favorites data is processed. (Inherited from Query.) |
|
Properties | Gets the query property bag. (Inherited from Query.) |
|
QueryInfo | Get the query log data for a single click-through for a search query. (Inherited from Query.) |
|
QueryTag | Gets or sets any custom tags to be used to identify the query. Multiple tags are separated by semicolons. (Inherited from Query.) |
|
QueryTemplate | Specifies the query template that is used at run time to transform the query based on user input. (Inherited from Query.) |
|
QueryTemplateParameters | Represents the parameters in the query template. (Inherited from Query.) |
|
QueryText | Gets or sets the text for the search query. (Inherited from Query.) |
|
RankingModelId | Gets or sets the identifier (ID) of the ranking model to use for the query. (Inherited from Query.) |
|
RefinementFilters | Gets or sets the set of refinement filters used. |
|
RefinementFilters_Client | The client-callable equivalent of RefinementFilters. |
|
Refiners | Gets or sets the set of refiners to be returned in a search result. The value for each refiner is a format string that specifies the name of a refiner and optionally a set of refinement options for this refiner. |
|
ReorderingRules | Gets or sets the collection of reordering rules (ReorderingRuleCollection). |
|
ResubmitFlags | Gets or sets the criteria for automatically resubmitting a search query that yielded no results. |
|
ResultsProvider | Gets or sets the search provider to use for the search query (Inherited from Query.) |
|
ResultsUrl | Gets or sets the results page URL of the query. (Inherited from Query.) |
|
ResultTypes | Obsolete. Gets or sets a value that specifies the search result type. (Inherited from Query.) |
|
RowLimit | Gets or sets the maximum number of rows returned in the search results, at the index specified by the StartRow() property. (Inherited from Query.) |
|
RowsPerPage | Gets or sets the number of search results to return per page. (Inherited from Query.) |
|
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. (Inherited from Query.) |
|
SearchTerms | Gets the terms used for the search query. |
|
SelectProperties | Gets a list of the properties to return in the search results. |
|
SelectProperties_Client | The client-callable equivalent of SelectProperties. |
|
ShowPeopleNameSuggestions | Specifies whether to generate name suggestions. (Inherited from Query.) |
|
SimilarTo | Obsolete. |
|
SimilarType | Obsolete.. |
|
Site | Gets the site from where the search query is run from. (Inherited from Query.) |
|
SiteContext | Gets or sets the site URL for the search query. (Inherited from Query.) |
|
SortList | Gets the list of properties by which the search results are ordered. |
|
SortSimilar | Obsolete. |
|
SourceId | Specifies the identifier (ID) of the result source to be used to run the query. (Inherited from Query.) |
|
StartRow | Gets or sets first row included in the search results. (Inherited from Query.) |
|
SummaryLength | Gets or sets the length of the search result summary. (Inherited from Query.) |
|
Timeout | Gets or sets the amount of time, in milliseconds, before the query request times out. (Inherited from Query.) |
|
TimeZone | Gets or sets the time zone for the search user. |
|
TotalRowsExactMinimum | Used by SearchPagingWebPart to determine the minimum value required for rendering page links. (Inherited from Query.) |
|
TrimDuplicates | Gets or sets a Boolean value that specifies whether duplicate items should be removed from the search results. (Inherited from Query.) |
|
TrimDuplicatesIncludeId | Specifies the value associated with a collapse group, typically used when a user clicks the Duplicates (n) link of an item with duplicates. |
|
TrimDuplicatesKeepCount | Gets or sets the number of duplicates to keep, if duplicates are returned in the search results. |
|
TrimDuplicatesOnProperty | Gets or sets the property the duplicates trimming is based on. |
|
UILanguage | Specifies the UI language. (Inherited from Query.) |
|
UrlZone | Gets the originating URL zone for the query request. (Inherited from Query.) |
|
UserContextData | Obsolete. |
|
UserContextGroupID | Obsolete. |
Top