Query members
SharePoint 2013
Represents the base class for executing search queries by using the SharePoint Enterprise Search query object model, and defines the properties and methods that are shared by the FullTextSqlQuery and KeywordQuery classes.
The Query type exposes the following members.
| Name | Description | |
|---|---|---|
|
Query(ServerContext) | Initializes a new instance of the Query class, based on the specified service application. |
|
|
Query(SPSite) | Initializes a new instance of the Query class, based on the specified site. |
|
|
Query(SPWeb) | |
|
|
Query(SearchServiceApplicationProxy) | Initializes a new instance of the Query class based on the specified Search service application. |
| Name | Description | |
|---|---|---|
|
AuthenticationType | Gets or sets the authentication type for the query. |
|
|
BlockDedupeMode | Set BlockRanking dedupe mode |
|
|
BypassResultTypes | |
|
|
ClientType | Name of a client which issued query. |
|
|
Culture | Gets or sets the locale for the query. |
|
|
Culture_Client | |
|
|
DesiredSnippetLength | |
|
|
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. |
|
|
EnableInterleaving | True if the ResultTables in the ResultTableCollection produced by executing this query should be interleaved. False otherwise. The default value is true. |
|
|
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. |
|
|
EnableOrderingHitHighlightedProperty | True if Hithighlighted properties are to be ordered by Hithighlighted terms |
|
|
EnablePhonetic | Gets or sets a Boolean value that specifies whether the phonetic forms of the query terms are used to find matches. |
|
|
EnableQueryRules | True if Query Rules are turned on for this query. False otherwise. The default value is true. |
|
|
EnableStemming | Gets or sets a Boolean value that specifies whether stemming is enabled. |
|
|
GenerateBlockRankLog | True to return block rank log info in the BlockRankLog property of the interleaved result table |
|
|
HighlightedSentenceCount |
Applies to: Microsoft SharePoint Server 2010 search Gets or sets the number of sentences to include in the hit-highlighted summary. |
|
|
Hint | Gets or sets the suggested query processor behavior for the query. |
|
|
HitHighlightedMultivaluePropertyLimit | Multi-valued hit highlighted property limit |
|
|
HitHighlightedProperties | Gets the collection of hit-highlighted properties for the query. |
|
|
HitHighlightedProperties_Client | |
|
|
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. |
|
|
IgnoreSafeQueryPropertiesTemplateUrl | Flag indicating that the SafeQueryPropertiesTemplateUrl property is not to be used. |
|
|
ImpressionID | 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 | |
|
|
PagingCookie |
Applies to: Microsoft SharePoint Server 2010 search Represents the client side cookie used for paging through the search results. |
|
|
PartitionId |
Applies to: Microsoft SharePoint Server 2010 search Specifies the unique identifier (ID) of the index partition to use for this search 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. |
|
|
PersonalizationData_Client | |
|
|
Priority | |
|
|
ProcessBestBets | True if the BestBets are requested. |
|
|
ProcessPersonalFavorites | True if the PersonalFavorites are requested. |
|
|
Properties | |
|
|
QueryInfo | Get the query log data for a single clickthrough for a search query. |
|
|
QueryTag | Any custom tags to be used to identify the query. Multiple tags are separated by semicolons. |
|
|
QueryTemplate | |
|
|
QueryTemplateParameters | |
|
|
QueryText | Gets or sets the text for the search query. |
|
|
RankingModelId |
Applies to: Microsoft SharePoint Server 2010 search Gets or sets the identifier (ID) of the ranking model to use for the query. |
|
|
ResultsProvider | Gets or sets the search provider used for the search query |
|
|
ResultsUrl | 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. |
|
|
RowsPerPage | Gets or sets the number of search results to return per page. |
|
|
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. |
|
|
ShowPeopleNameSuggestions | Whether to generate name suggestions . |
|
|
Site | Gets the site the search query is executed from. |
|
|
SiteContext | Gets or sets the site URL for the search query. |
|
|
SourceId | The identifier of the the source to be used to run the query. |
|
|
StartRow | Gets or sets first row included in the search results. |
|
|
SummaryLength |
Applies to: Microsoft SharePoint Server 2010 search Gets or sets the length of the search result summary. |
|
|
Timeout |
Applies to: Microsoft SharePoint Server 2010 search Gets or sets the amount of time, in milliseconds, before the query request times out. |
|
|
TotalRowsExactMinimum |
Applies to: Microsoft SharePoint Server 2010 search 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. For FAST Search Server 2010 for SharePoint, this property can also be used to collapse hits in the result set. |
|
|
UILanguage | |
|
|
UrlZone | Gets the originating URL zone for the query request. |
| Name | Description | |
|---|---|---|
|
|
Dispose | Disposes the instance of the Query class. |
|
|
Equals | (Inherited from Object.) |
|
|
Execute | Obsolete. Executes the search query. |
|
Finalize | (Inherited from Object.) |
|
|
GetHashCode | (Inherited from Object.) |
|
|
GetProperties | Returns information about managed properties. |
|
|
GetQuerySuggestions | Returns a list of query suggestions matching the search terms typed in the search box. |
|
|
GetQuerySuggestionsWithResults | |
|
|
GetScopes | Returns information about search scopes. |
|
|
GetType | (Inherited from Object.) |
|
|
HighlightStringValue |
Applies to: Microsoft SharePoint Server 2010 search Highlights all the occurrences of the specified query terms in a string. |
|
|
MemberwiseClone | (Inherited from Object.) |
|
|
SetConfigurableDefaults | |
|
|
SetDefaults | |
|
|
ToString | (Inherited from Object.) |
