KeywordQuery members
SharePoint 2013
Represents a search query that uses the SharePoint Enterprise Search keyword syntax. For information about constructing keyword queries, see the Keyword Query Syntax Reference.
The KeywordQuery type exposes the following members.
| Name | Description | |
|---|---|---|
|
KeywordQuery() | |
|
|
KeywordQuery(ServerContext) | Initializes a new instance of the KeywordQuery class, based on the specified service application context. |
|
|
KeywordQuery(SPSite) | Initializes a new instance of the KeywordQuery class, based on the specified site. |
|
|
KeywordQuery(SPWeb) | |
|
|
KeywordQuery(String) | Obsolete. Initializes a new instance of the KeywordQuery class, based on the specified application name. |
|
|
KeywordQuery(SearchServiceApplicationProxy) | Initializes a new instance of the KeywordQuery class, based on the specified Search service application. |
| Name | Description | |
|---|---|---|
|
AuthenticationType | Gets or sets the authentication type for the query. (Inherited from Query.) |
|
|
BlockDedupeMode | Set BlockRanking dedupe mode (Inherited from Query.) |
|
|
BypassResultTypes | (Inherited from Query.) |
|
|
ClientType | Name of a client which issued query. (Inherited from Query.) |
|
|
CollapseSpecification | |
|
|
Culture | Gets or sets the locale for the query. (Inherited from Query.) |
|
|
Culture_Client | (Inherited from Query.) |
|
|
CustomRefinementIntervals |
Applies to: Microsoft FAST Search Server 2010 for SharePoint Gets or sets the refinement intervals that should be imposed on the FAST Search Server 2010 for SharePoint refinements. |
|
|
DesiredSnippetLength | (Inherited from Query.) |
|
|
DirectServiceEndpointUri | Gets or sets the address the Search service application proxy should use instead of the URL specified in the constructor for the Search service application proxy. (Inherited from Query.) |
|
|
EnableFQL |
Applies to: Microsoft FAST Search Server 2010 for SharePoint Gets or sets a Boolean value that specifies whether the query string is according to the FAST Query Language (FQL) syntax. For details, see FAST Query Language (FQL) Syntax Reference. |
|
|
EnableInterleaving | True if the ResultTables in the ResultTableCollection produced by executing this query should be interleaved. False otherwise. The default value is true. (Inherited from Query.) |
|
|
EnableNicknames |
Applies to: Microsoft SharePoint Server 2010 search 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 | True if Hithighlighted properties are to be ordered by Hithighlighted 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 | True if Query Rules are turned on for this query. False otherwise. The default value is true. (Inherited from Query.) |
|
|
EnableSorting | Indicates whether results are to be sorted If true, results are sorted using SortList, or by rank if SortList is empy If false, results are not sorted |
|
|
EnableSpellcheck |
Applies to: Microsoft FAST Search Server 2010 for SharePoint Specifies how to apply spell correction of the query terms when processing the query. For details, see Linguistic Query Features. |
|
|
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" (creating a URL by combining the query terms) is enabled. |
|
|
GenerateBlockRankLog | True to return block rank log info in the BlockRankLog property of the interleaved result table (Inherited from Query.) |
|
|
GenerationId | |
|
|
HiddenConstraints |
Applies to: Microsoft SharePoint Server 2010 search Gets or sets the keyword query’s hidden constraints. |
|
|
HighlightedSentenceCount |
Applies to: Microsoft SharePoint Server 2010 search Gets or sets the number of sentences to include in the hit-highlighted summary. (Inherited from Query.) |
|
|
Hint | Gets or sets the suggested query processor behavior for the query. (Inherited from Query.) |
|
|
HitHighlightedMultivaluePropertyLimit | 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 | (Inherited from Query.) |
|
|
IgnoreAllNoiseQuery |
Applies to: Microsoft SharePoint Server 2010 search Gets or sets a Boolean value that specifies whether the search query should execute if the query text contains only noise words. (Inherited from Query.) |
|
|
IgnoreSafeQueryPropertiesTemplateUrl | Flag indicating that the SafeQueryPropertiesTemplateUrl property is not to be used. (Inherited from Query.) |
|
|
ImpressionID | ID of the page impression. (Inherited from Query.) |
|
|
IsCachable | |
|
|
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 | |
|
|
MaxShallowRefinementHits |
Applies to: Microsoft FAST Search Server 2010 for SharePoint Gets or sets the number of results to be used to calculate shallow refinement results. |
|
|
MaxSnippetLength | (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 |
Applies to: Microsoft SharePoint Server 2010 search Represents the client side cookie used for paging through the search results. (Inherited from Query.) |
|
|
PartitionId |
Applies to: Microsoft SharePoint Server 2010 search Specifies the unique identifier (ID) of the index partition to use for this search query. (Inherited from Query.) |
|
|
PersonalizationData |
Applies to: Microsoft SharePoint Server 2010 search Gets or sets the unique identifier (ID) for the current user who submitted the search query. (Inherited from Query.) |
|
|
PersonalizationData_Client | (Inherited from Query.) |
|
|
Priority | (Inherited from Query.) |
|
|
ProcessBestBets | True if the BestBets are requested. (Inherited from Query.) |
|
|
ProcessPersonalFavorites | True if the PersonalFavorites are requested. (Inherited from Query.) |
|
|
Properties | (Inherited from Query.) |
|
|
QueryInfo | Get the query log data for a single clickthrough for a search query. (Inherited from Query.) |
|
|
QueryTag | Any custom tags to be used to identify the query. Multiple tags are separated by semicolons. (Inherited from Query.) |
|
|
QueryTemplate | (Inherited from Query.) |
|
|
QueryTemplateParameters | (Inherited from Query.) |
|
|
QueryText | Gets or sets the text for the search query. (Inherited from Query.) |
|
|
RankingModelId |
Applies to: Microsoft SharePoint Server 2010 search Gets or sets the identifier (ID) of the ranking model to use for the query. (Inherited from Query.) |
|
|
RefinementFilters |
Applies to: Microsoft FAST Search Server 2010 for SharePoint Gets or sets the set of refinement filters used when issuing a refinement query. |
|
|
RefinementFilters_Client | |
|
|
Refiners |
Applies to: Microsoft FAST Search Server 2010 for SharePoint 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. For details, see Specifying Refiners. Default: No refiners will be returned with the query result if the Refiners property is empty. |
|
|
ReorderingRules | |
|
|
ResubmitFlags |
Applies to: Microsoft FAST Search Server 2010 for SharePoint Gets or sets the criteria for automatically resubmitting a search query that yielded no results. |
|
|
ResultsProvider | Gets or sets the search provider used for the search query (Inherited from Query.) |
|
|
ResultsUrl | 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. (Inherited from Query.) |
|
|
RowsPerPage | Gets or sets the number of search results to return per page. (Inherited from Query.) |
|
|
SafeQueryPropertiesTemplateUrl | Used by CSOM clients to specify the location of the QueryProperties template. This property must be specified when issuing a query by a user without the UseRemoteAPIs permission. If the query is not to be executed without UseRemoteAPIs then is possible to 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 | |
|
|
ShowPeopleNameSuggestions | Whether to generate name suggestions . (Inherited from Query.) |
|
|
SimilarTo |
Applies to: Microsoft FAST Search Server 2010 for SharePoint Gets or sets the similarity reference when performing a find similar query. For details, see Find Similar. |
|
|
SimilarType |
Applies to: Microsoft FAST Search Server 2010 for SharePoint Gets or sets the type of find similar query to perform. For details, see Find Similar. |
|
|
Site | Gets the site the search query is executed 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 |
Applies to: Microsoft FAST Search Server 2010 for SharePoint Gets or sets a Boolean value that specifies whether query results based on similarity shall be sorted by similarity. For details, see Find Similar. |
|
|
SourceId | The identifier of the the 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 |
Applies to: Microsoft SharePoint Server 2010 search Gets or sets the length of the search result summary. (Inherited from Query.) |
|
|
Timeout |
Applies to: Microsoft SharePoint Server 2010 search 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 |
Applies to: Microsoft SharePoint Server 2010 search 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. For FAST Search Server 2010 for SharePoint, this property can also be used to collapse hits in the result set. (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 | (Inherited from Query.) |
|
|
UrlZone | Gets the originating URL zone for the query request. (Inherited from Query.) |
|
|
UserContextData |
Applies to: Microsoft FAST Search Server 2010 for SharePoint Gets or sets the user context data associated with the FAST Search Server 2010 for SharePoint search settings. |
|
|
UserContextGroupID |
Applies to: Microsoft FAST Search Server 2010 for SharePoint Gets or sets the identifier used to group keywords used for matching best bets and visual best bets. This property specifies an identifier used to group keywords used for matching best bets and visual best bets. See also Keyword Management. |
| Name | Description | |
|---|---|---|
|
|
Dispose | Disposes the instance of the Query class. (Inherited from Query.) |
|
|
Equals | (Inherited from Object.) |
|
|
Execute | Obsolete. Executes the search query. (Inherited from Query.) |
|
Finalize | (Inherited from Object.) |
|
|
GetHashCode | (Inherited from Object.) |
|
|
GetProperties | Returns information about managed properties. (Inherited from Query.) |
|
|
GetQuerySuggestions | Returns a list of query suggestions matching the search terms typed in the search box. (Inherited from Query.) |
|
|
GetQuerySuggestionsWithResults | (Inherited from Query.) |
|
|
GetScopes | Returns information about search scopes. (Inherited from Query.) |
|
|
GetType | (Inherited from Object.) |
|
|
HighlightStringValue |
Applies to: Microsoft SharePoint Server 2010 search Highlights all the occurrences of the specified query terms in a string. (Inherited from Query.) |
|
|
MemberwiseClone | (Inherited from Object.) |
|
|
SetConfigurableDefaults | (Inherited from Query.) |
|
|
SetDefaults | (Inherited from Query.) |
|
|
ToString | (Inherited from Object.) |
