KeywordQueryProperties members

Represents the properties for a search query using the Keyword syntax.

The KeywordQueryProperties type exposes the following members.

Constructors

  Name Description
Public method KeywordQueryProperties Initializes a new instance of the KeywordQueryProperties class.

Top

Properties

  Name Description
Public property AlertInfo Obsolete. Gets or sets information about an alert. (Inherited from QueryProperties.)
Public property AuthenticationType Gets or sets the authentication type for the query. (Inherited from QueryProperties.)
Public property BlockDedupeMode 0: None, 1:SubstrateOnly, 2:All, 3:RemoveBlockIfTopResultIdDupe (Inherited from QueryProperties.)
Public property BypassResultTypes (Inherited from QueryProperties.)
Public property ClientType Name of a client which issued query. (Inherited from QueryProperties.)
Public property CollapseSpecification
Public property CorrelationId Gets or sets the identifier (ID) for a Unified Logging Service (ULS) entry. (Inherited from QueryProperties.)
Public property Culture Gets or sets the locale for the query. (Inherited from QueryProperties.)
Public property CustomRefinementIntervals Gets or sets the refinement intervals that should be imposed on the FAST Search Server 2010 for SharePoint refinements.
Public property DesiredSnippetLength (Inherited from QueryProperties.)
Public property EnableFQL Gets or sets a Boolean value that specifies whether the FAST Query Language (FQL) is enabled for the query.
Public property 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 QueryProperties.)
Public property 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 QueryProperties.)
Public property EnableOrderingHitHighlightedProperty Enable sort order for Hithighlighted property values (Inherited from QueryProperties.)
Public property EnablePhonetic Gets or sets a Boolean value that specifies whether the phonetic forms of the query terms are used to find matches. (Inherited from QueryProperties.)
Public property EnableQueryRules True if Query Rules are turned on for this query. False otherwise. The default value is true. (Inherited from QueryProperties.)
Public property EnableResultBlocksOnAllPages (Inherited from QueryProperties.)
Public property EnableResultBlocksOnRefinement (Inherited from QueryProperties.)
Public property EnableSorting
Public property EnableSpellcheck Specifies how to apply spell correction of the query terms when processing the query.
Public property EnableStemming Gets or sets a Boolean value that specifies whether stemming is enabled. (Inherited from QueryProperties.)
Public property EnableUrlSmashing Gets or sets a Boolean value that specifies whether "URL smashing" (creating a URL by combining the query terms) is enabled.
Public property FarmId (Inherited from QueryProperties.)
Public property GenerateBlockRankLog Defaults to false (Inherited from QueryProperties.)
Public property GenerationId Gets or sets the generation identifier (ID).
Public property HiddenConstraints Gets or sets the keyword query’s hidden constraints.
Public property Hint Gets or sets the suggested query processor behavior for the query. (Inherited from QueryProperties.)
Public property HitHighlightedMultivaluePropertyLimit Number of values to return (Inherited from QueryProperties.)
Public property HitHighlightedProperties Gets the list of hit-highlighted properties. (Inherited from QueryProperties.)
Public property Id A client generated identifier for the query. SearchExecutor.ExecuteQueries expect this property to be given a value and for ids of all Queries passed in a call to it to be different. (Inherited from QueryProperties.)
Public property IgnoreAllNoiseQuery Gets or sets a Boolean value that specifies whether the search query should execute if the query text contains only noise words. (Inherited from QueryProperties.)
Public property ImpressionID ID of the page impression. (Inherited from QueryProperties.)
Public property IntentQueryId (Inherited from QueryProperties.)
Public property IsCachable Gets or sets a Boolean value that indicates if the query is cacheable.
Public property IsUserAdmin True if query user is an administrator (Inherited from QueryProperties.)
Public property Item (Inherited from QueryProperties.)
Public property 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 QueryProperties.)
Public property Locale (Inherited from QueryProperties.)
Public property MaxKeywordQueryTextLength
Public property MaxRowLimit Maximum value for row limit (Inherited from QueryProperties.)
Public property MaxShallowRefinementHits Gets or sets the number of results to be used to calculate shallow refinement results.
Public property MaxSnippetLength (Inherited from QueryProperties.)
Public property MaxSummaryLength Gets or sets the maximum length of the search result summary.
Public property MaxTimeout Maximum value for query timeout (Inherited from QueryProperties.)
Public property MaxUrlLength Gets or sets the maximum length of the search result URL.
Public property MergeWithDefaultPartition Gets or sets a Boolean value that specifies whether the default search partition should be queried. (Inherited from QueryProperties.)
Public property OriginalQueryText (Inherited from QueryProperties.)
Public property PagingCookie Gets or sets a client-side state cookie that tracks the number of query results filtered out by security trimming. (Inherited from QueryProperties.)
Public property PartitionId Specifies the unique identifier (ID) of the index partition to use for this search query. (Inherited from QueryProperties.)
Public property PersonalizationData Gets or sets the unique identifier (ID) for the current user who submitted the search query. (Inherited from QueryProperties.)
Public property Priority (Inherited from QueryProperties.)
Public property ProcessBestBets The identifier of the the source to be used to run the query. (Inherited from QueryProperties.)
Public property ProcessPersonalFavorites True if personal favorites need to be returned. (Inherited from QueryProperties.)
Public property PropertiesContractVersion (Inherited from QueryProperties.)
Public property QueryTag Any custom tags to be used to identify the query. Multiple tags are separated by semicolons. (Inherited from QueryProperties.)
Public property QueryTemplate (Inherited from QueryProperties.)
Public property QueryTemplateParameters (Inherited from QueryProperties.)
Public property QueryText Gets or sets the text for the search query. (Inherited from QueryProperties.)
Public property RankingModelId Gets or sets the ranking model identifier (ID). (Inherited from QueryProperties.)
Public property RefinementFilters Gets or sets the set of refinement filters used when issuing a refinement query.
Public property Refiners Gets or sets the set of refiners to be returned in a search result.
Public property ReorderingRules
Public property ResubmitFlags Gets or sets the criteria for automatically resubmitting a search query that yielded no results.
Public property ResultsProvider Gets or sets the search provider for the query. (Inherited from QueryProperties.)
Public property ResultsUrl Results page url of the query (Inherited from QueryProperties.)
Public property ResultTypes Gets or sets a value that specifies the search result type. (Inherited from QueryProperties.)
Public property RowLimit Gets or sets the maximum number of rows returned in the search results. (Inherited from QueryProperties.)
Public property RowsPerPage Gets or sets the number of search results to return per page. (Inherited from QueryProperties.)
Public property SelectProperties Gets a list of the properties to return in the search results.
Public property ShowPeopleNameSuggestions Whether to show name suggestions (Inherited from QueryProperties.)
Public property Sid Gets or sets the query’s security identifier (SID). (Inherited from QueryProperties.)
Public property SimilarTo Gets or sets the similarity reference when performing a find similar query.
Public property SimilarType Gets or sets the type of find similar query to perform.
Public property SiteId Gets or sets the identifier (ID) for the site associated with the query. (Inherited from QueryProperties.)
Public property SortList Gets the list of properties by which the search results are ordered.
Public property SortSimilar Gets or sets a Boolean value that specifies whether query results based on similarity shall be sorted by similarity.
Public property SourceId The identifier of the the source to be used to run the query. (Inherited from QueryProperties.)
Public property StartRow Gets or sets first row included in the search results. (Inherited from QueryProperties.)
Public property SummaryLength Gets or sets the length of the search result summary. (Inherited from QueryProperties.)
Public property Timeout Gets or sets the amount of time, in milliseconds, before the query request times out. (Inherited from QueryProperties.)
Public property TimeZoneID Gets or sets the identifier for the search query time zone. (Inherited from QueryProperties.)
Public property TotalRowsExactMinimum Used by SearchPagingWebPart to determine the minimum value required for rendering page links. (Inherited from QueryProperties.)
Public property TrimDuplicates Gets or sets a Boolean value that specifies whether duplicate items should be removed from the search results. (Inherited from QueryProperties.)
Public property TrimDuplicatesIncludeId Gets or sets the identifier (ID) of the duplicate documents to include.
Public property TrimDuplicatesKeepCount Gets or sets the number of duplicates to keep if duplicates are returned in the search results.
Public property TrimDuplicatesOnProperty Gets or sets the property the duplicates trimming is based on.
Public property UILanguage (Inherited from QueryProperties.)
Public property UrlZone Gets the originating URL zone for the query request. (Inherited from QueryProperties.)
Public property UserContextData Gets or sets the user context data associated with the FAST Search Server 2010 for SharePoint search settings.
Public property UserContextGroupID Gets or sets the user context identifier (ID) for contextual search.
Public property WcfTimeout Gets or sets the amount of time before the query’s WCF operations time out. (Inherited from QueryProperties.)
Public property WebId (Inherited from QueryProperties.)
Public property WebTemplate Maximum value for query timeout (Inherited from QueryProperties.)

Top

Methods

  Name Description
Public method Clone (Overrides QueryProperties.Clone().)
Public method ContainsKey (Inherited from QueryProperties.)
Protected method EnsureInitialized() (Inherited from QueryProperties.)
Protected method EnsureInitialized(Boolean) (Inherited from QueryProperties.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetEnumerator (Inherited from QueryProperties.)
Public method GetFormattedString (Inherited from QueryProperties.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method Initialize (Overrides QueryProperties.Initialize(Boolean).)
Protected method InternalClone (Inherited from QueryProperties.)
Public method IsSupported (Inherited from QueryProperties.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString Returns an XML-formatted representation of the object instance. (Inherited from QueryProperties.)
Public method TryGetValue (Inherited from QueryProperties.)
Protected method ValidatePropertiesAfterDeserialization (Overrides QueryProperties.ValidatePropertiesAfterDeserialization().)

Top

Fields

  Name Description
Protected field _deserializing (Inherited from QueryProperties.)

Top

Explicit interface implementations

  Name Description
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator (Inherited from QueryProperties.)
Explicit interface implemetationPrivate property IReadOnlyPropertyCollection.Item (Inherited from QueryProperties.)

Top

See also

Reference

KeywordQueryProperties class

Microsoft.Office.Server.Search.Query namespace