QueryProperties members

Article
05/27/2015

Represents the properties for a search query.

The QueryProperties type exposes the following members.

Constructors

	Name	Description
	QueryProperties	Initializes a new instance of the QueryProperties class.

Top

Properties

	Name	Description
	AlertInfo	Obsolete. Gets or sets information about an alert.
	AuthenticationType	Gets or sets the authentication type for the query.
	BlockDedupeMode	0: None, 1:SubstrateOnly, 2:All, 3:RemoveBlockIfTopResultIdDupe
	BypassResultTypes
	ClientType	Name of a client which issued query.
	CorrelationId	Gets or sets the identifier (ID) for a Unified Logging Service (ULS) entry.
	Culture	Gets or sets the locale for the query.
	DesiredSnippetLength
	EnableInterleaving	True if the ResultTables in the ResultTableCollection produced by executing this query should be interleaved. False otherwise. The default value is true.
	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.
	EnableOrderingHitHighlightedProperty	Enable sort order for Hithighlighted property values
	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.
	EnableResultBlocksOnAllPages
	EnableResultBlocksOnRefinement
	EnableStemming	Gets or sets a Boolean value that specifies whether stemming is enabled.
	FarmId
	GenerateBlockRankLog	Defaults to false
	Hint	Gets or sets the suggested query processor behavior for the query.
	HitHighlightedMultivaluePropertyLimit	Number of values to return
	HitHighlightedProperties	Gets the list of hit-highlighted properties.
	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.
	IgnoreAllNoiseQuery	Gets or sets a Boolean value that specifies whether the search query should execute if the query text contains only noise words.
	ImpressionID	ID of the page impression.
	IntentQueryId
	IsUserAdmin	True if query user is an administrator
	Item
	KeywordInclusion	Gets or sets a value that specifies whether the query returns results that contain all or any of the specified search terms.
	Locale
	MaxRowLimit	Maximum value for row limit
	MaxSnippetLength
	MaxTimeout	Maximum value for query timeout
	MergeWithDefaultPartition	Gets or sets a Boolean value that specifies whether the default search partition should be queried.
	OriginalQueryText
	PagingCookie	Gets or sets a client-side state cookie that tracks the number of query results filtered out by security trimming.
	PartitionId	Specifies the unique identifier (ID) of the index partition to use for this search query.
	PersonalizationData	Gets or sets the unique identifier (ID) for the current user who submitted the search query.
	Priority
	ProcessBestBets	The identifier of the the source to be used to run the query.
	ProcessPersonalFavorites	True if personal favorites need to be returned.
	PropertiesContractVersion
	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	Gets or sets the ranking model identifier (ID).
	ResultsProvider	Gets or sets the search provider for the query.
	ResultsUrl	Results page url of the query
	ResultTypes	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.
	ShowPeopleNameSuggestions	Whether to show name suggestions
	Sid	Gets or sets the query’s security identifier (SID).
	SiteId	Gets or sets the identifier (ID) for the site associated with the 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	Gets or sets the length of the search result summary.
	Timeout	Gets or sets the amount of time, in milliseconds, before the query request times out.
	TimeZoneID	Gets or sets the identifier for the search query time zone.
	TotalRowsExactMinimum	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.
	UILanguage
	UrlZone	Gets the originating URL zone for the query request.
	WcfTimeout	Gets or sets the amount of time before the query’s WCF operations time out.
	WebId
	WebTemplate	Maximum value for query timeout

Top

Methods

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