KeywordQuery Class - eguimaraes/sharepoint GitHub Wiki
KeywordQuery Class
Definition Namespace: Microsoft.SharePoint.Client.Search.Query Assembly: Microsoft.SharePoint.Client.Search.dll Contains information about a keyword based search query. Represents a search query that uses the SharePoint Server 2013 keyword syntax. This syntax may contain either the Keyword Query Language (KQL) or FAST Query Language (FQL). For information about constructing keyword queries, see the Building search queries in SharePoint 2013.
C++
Copy public ref class KeywordQuery sealed : Microsoft::SharePoint::Client::Search::Query::Query Inheritance Microsoft.SharePoint.Client.ClientObjectQueryKeywordQuery Attributes Microsoft.SharePoint.Client.ScriptTypeAttribute Constructors KeywordQuery(ClientRuntimeContext) KeywordQuery(ClientRuntimeContext, ObjectPath) Properties 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) DesiredSnippetLength Gets or sets the preferred summary length.
(Inherited from Query) EnableInterleaving A Boolean value that specifies whether the ResultTable objects in the ResultTableCollection produced by running this query should be interleaved.
(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..
(Inherited from Query) EnableSorting A Boolean value that indicates whether the search results should be sorted.
EnableStemming Gets or sets a Boolean value that specifies whether stemming is enabled.
(Inherited from Query) 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) HiddenConstraints Gets or sets the keyword query’s hidden constraints.
HitHighlightedMultivaluePropertyLimit Gets or sets the multi-valued hit highlighted property limit.
(Inherited from Query) HitHighlightedProperties Gets the collection of hit highlighted properties for the query.
(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) MaxSnippetLength Specifies the maximum length of the result summary.
(Inherited from Query) PersonalizationData Gets or sets the user personalization data for the current user who submitted the search 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 or not.
(Inherited from Query) Properties Gets the keyword query property bag.
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 The query text of 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.
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).
ResultsUrl Gets or sets the results page URL of the query.
(Inherited from Query) RowLimit Gets or sets the maximum number of rows returned in the search results, starting 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) SelectProperties Gets a list of properties to return in the search results.
ShowPeopleNameSuggestions Specifies whether to generate name suggestions.
(Inherited from Query) SortList Gets the list of properties by which the search results are ordered.
SourceId Specifies the identifier (ID) of the result source to be used to run the query.
(Inherited from Query) StartRow Gets or sets the 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) TimeZoneId TotalRowsExactMinimum Used by the SearchPagingWebPart object to determine the minimum value required for rendering page links.
(Inherited from Query) TrimDuplicates 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) TrimDuplicatesIncludeId Specifies the value associated with a collapse group, typically used when a user clicks the Duplicates (n) link of an item with duplicates.
UILanguage Specifies the UI language.
(Inherited from Query) Methods GetQueryCompletions(Int32, String, Int32) Inherited from Query GetQuerySuggestionsWithResults(Int32, Int32, Boolean, Boolean, Boolean, Boolean) Returns a list of query suggestions matching the search terms typed in the search box.
(Inherited from Query) InitOnePropertyFromJson(String, JsonReader) Inherited from Query Applies to SharePoint Server Latest Feedback