DataProviderScriptWebPart members

A ScriptWebPart that issues queries and coordinates all other ScriptWebParts that belong to the same query group.

The DataProviderScriptWebPart type exposes the following members.

Constructors

	Name	Description
	DataProviderScriptWebPart	Constructs a Script Web Part that issues queries and coordinates all other Script Web Parts that belong to the same query group.

Top

Properties

	Name	Description
	AccessKey	(Inherited from WebControl.)
	Active	Specifies whether the Data Provider is active.
	Adapter	(Inherited from Control.)
	AllowClose	(Inherited from WebPart.)
	AllowConnect	(Inherited from WebPart.)
	AllowEdit	(Inherited from WebPart.)
	AllowHide	(Inherited from WebPart.)
	AllowMinimize	(Inherited from WebPart.)
	AllowRemove	Obsolete. (Inherited from WebPart.)
	AllowZoneChange	(Inherited from WebPart.)
	AlternateErrorMessage	Gets or sets the alternate visitor error message to show. (Inherited from ScriptWebPart.)
	AppManager	(Inherited from ScriptWebPart.)
	AppRelativeTemplateSourceDirectory	(Inherited from Control.)
	AsynchronousResultRetrieval	Specifies whether the Data Provider is in synchronous mode.
	Attributes	(Inherited from WebControl.)
	AuthorizationFilter	(Inherited from WebPart.)
	AvailableSorts	List of available sort options.
	BackColor	(Inherited from WebControl.)
	BackImageUrl	(Inherited from Panel.)
	BatchClientQuery	Specifies whether the Data Provider should batch queries on the client side.
	BindingContainer	(Inherited from Control.)
	BorderColor	(Inherited from WebControl.)
	BorderStyle	(Inherited from WebControl.)
	BorderWidth	(Inherited from WebControl.)
	BrowserDesignMode	Obsolete. (Inherited from WebPart.)
	BypassResultTypes	Flag to ignore result types.
	CacheType	(Inherited from WebPart.)
	Caption	Obsolete. (Inherited from WebPart.)
	CatalogIconImageUrl	(Inherited from WebPart.)
	ChildControlsCreated	(Inherited from Control.)
	ChromeState	(Inherited from WebPart.)
	ChromeType	(Inherited from WebPart.)
	ClassResourcePath	(Inherited from WebPart.)
	ClientControlType	Gets the client control type of the current control. (Inherited from ScriptWebPart.)
	ClientID	(Inherited from Control.)
	ClientIDMode	(Inherited from Control.)
	ClientIDSeparator	(Inherited from Control.)
	ClientName	(Inherited from WebPart.)
	ClientType	Specifies the type of client issuing the queries.
	CollapseSpecification	Specifies the query collapse specification.
	ConnectErrorMessage	(Inherited from WebPart.)
	ConnectionID	(Inherited from WebPart.)
	Connections	(Inherited from WebPart.)
	ContainerWidth	Obsolete. (Inherited from WebPart.)
	Context	(Inherited from Control.)
	ContextualScopeUrl	Specifies the site URL of the contextual search.
	Controls	(Inherited from Part.)
	ControlStyle	(Inherited from WebControl.)
	ControlStyleCreated	(Inherited from WebControl.)
	CsrContainerId	(Inherited from ScriptWebPart.)
	CssClass	(Inherited from WebControl.)
	CssStyleSheet	(Inherited from WebPart.)
	DataItemContainer	(Inherited from Control.)
	DataKeysContainer	(Inherited from Control.)
	DefaultButton	(Inherited from Panel.)
	DelayLoadTemplateScripts	(Overrides ScriptWebPart.DelayLoadTemplateScripts.)
	Description	(Inherited from WebPart.)
	DesignMode	(Inherited from Control.)
	DesiredSnippetLength	Specifies the desired snippet length.
	DetailLink	Obsolete. (Inherited from WebPart.)
	Dir	Obsolete. (Inherited from WebPart.)
	Direction	(Inherited from WebPart.)
	DisplayTitle	(Inherited from WebPart.)
	EffectiveFrameType	Obsolete. (Inherited from WebPart.)
	EffectiveStorage	(Inherited from WebPart.)
	EffectiveTitle	(Inherited from WebPart.)
	EmitStyleReference	(Inherited from ScriptWebPart.)
	Enabled	(Inherited from WebControl.)
	EnableInterleaving	A Boolean value that determines whether the substrate result table should interleave different result sets based on the query rules.
	EnableNicknames	A Boolean value that determines whether nickname expansion is enabled on the current query.
	EnableOrderingHitHighlightedProperty	A Boolean value that determines the ordering of hit highlighted properties.
	EnablePhonetic	A Boolean value that determines whether phonetic name expansion is enabled on the current query.
	EnableQueryRules	A Boolean value that determines whether query rules are enabled on the current query.
	EnableStemming	A Boolean value that determines whether stemming is enabled on the current query.
	EnableTheming	(Inherited from WebControl.)
	EnableViewState	(Inherited from Control.)
	Events	(Inherited from Control.)
	ExportControlledProperties	Obsolete. (Inherited from WebPart.)
	ExportMode	(Inherited from WebPart.)
	FallbackLanguage	Specifies the language fallback for all queries to be issued by this Data Provider.
	FallbackRankingModelID	Specifies the ranking model fallback for all queries issued by this Data Provider.
	FallbackRefinementFilters	Specifies the refinement filters fallback to be applied to all queries issued by this Data Provider.
	FallbackSort	Specifies the sort fallback that is applied to all queries issued by this Data Provider.
	FallbackSortJson	Specifies the sort fallback that is applied to all queries issued by this Data Provider. The JSON equivalent of FallbackSort.
	Font	(Inherited from WebControl.)
	ForeColor	(Inherited from WebControl.)
	FrameState	Obsolete. (Inherited from WebPart.)
	FrameType	Obsolete. (Inherited from WebPart.)
	GroupingText	(Inherited from Panel.)
	HasAttributes	(Inherited from WebControl.)
	HasChildViewState	(Inherited from Control.)
	HasSharedData	(Inherited from WebPart.)
	HasUserData	(Inherited from WebPart.)
	Height	(Inherited from WebPart.)
	HelpLink	Obsolete. (Inherited from WebPart.)
	HelpMode	(Inherited from WebPart.)
	HelpUrl	(Inherited from WebPart.)
	Hidden	(Inherited from WebPart.)
	HitHighlightedMultivaluePropertyLimit	Represents a multi-valued hit highlighted property limit.
	HitHighlightedProperties	Gets the collection of hit highlighted properties for the query.
	HorizontalAlign	(Inherited from Panel.)
	ID	(Inherited from WebPart.)
	IdSeparator	(Inherited from Control.)
	IgnoreContextualScope
	IgnoreQueryPropertiesTemplateUrl	Gets or sets a flag that indicates whether QueryPropertiesTemplateUrl property should be ignored.
	IgnoreStaleServerQuery
	ImportErrorMessage	(Inherited from WebPart.)
	InitialQueryState	Specifies the initial query state to use in the absence of user specified query state.
	InitialResult	Specifies the results of the initial query if the Data Provider is both synchronous and active. Otherwise, this property is empty.
	InitialResultRef	Specifies the variable name of the results of the initial query, if the Data Provider is both synchronous and active. Otherwise, this property is empty. This value is populated when the request is flushed before the query is run.
	IsChildControlStateCleared	(Inherited from Control.)
	IsClosed	(Inherited from WebPart.)
	IsEnabled	(Inherited from WebControl.)
	IsIncluded	Obsolete. (Inherited from WebPart.)
	IsIncludedFilter	Obsolete. (Inherited from WebPart.)
	IsPageInEditMode	(Inherited from ScriptWebPart.)
	IsShared	(Inherited from WebPart.)
	IsStandalone	(Inherited from WebPart.)
	IsStatic	(Inherited from WebPart.)
	IsTrackingViewState	(Inherited from Control.)
	IsViewStateEnabled	(Inherited from Control.)
	IsVisible	Obsolete. (Inherited from WebPart.)
	LoadViewStateByID	(Inherited from Control.)
	MaxPagesAfterCurrent	Specifies the maximum number of pages after the current page of results for which to display paging links.
	Messages	Gets the list of error and information messages for the current Web Part. (Inherited from ScriptWebPart.)
	MissingAssembly	Obsolete. (Inherited from WebPart.)
	NamingContainer	(Inherited from Control.)
	OverflowAuto	(Inherited from WebPart.)
	Page	(Inherited from Control.)
	Parent	(Inherited from Control.)
	PartImageLarge	Obsolete. (Inherited from WebPart.)
	PartImageSmall	Obsolete. (Inherited from WebPart.)
	PartOrder	Obsolete. (Inherited from WebPart.)
	Permissions	Obsolete. (Inherited from WebPart.)
	PersonalizedQuery	Gets or sets a flag that indicates whether the query should be personalized.
	ProcessBestBets	Gets or sets a flag that indicates whether best bets should be processed.
	ProcessPersonalFavorites	Gets or sets a flag that indicates whether personal favorites should be processed.
	Properties	Specifies the property bag for user defined basic type properties.
	PropertiesJson	Specifies the property bag for user defined basic type properties. The JSON equivalent of Properties.
	Qualifier	(Inherited from WebPart.)
	QueryGroupName	Specifies the query group name.
	QueryPropertiesTemplateUrl	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 IgnoreQueryPropertiesTemplateUrl() property to true instead.
	QueryTemplate	Specifies the query template.
	RankRules	Gets or sets a set of rank rules that are applied to all queries issued by this Data Provider.
	RankRulesJson	Gets or sets a set of rank rules that are applied to all queries issued by this Data Provider. The JSON equivalent of RankRules.
	RenderingCompatibility	(Inherited from Control.)
	RenderTemplateId	Gets or sets the control render template name. (Inherited from ScriptWebPart.)
	ResultsPerPage	Specifies the number of results to display per page.
	SaveProperties	(Inherited from WebPart.)
	ScopeResultsToCurrentSite	Limits the search scope to the current site.
	ScriptSerializer	(Inherited from ScriptWebPart.)
	ScrollBars	(Inherited from Panel.)
	SelectedProperties	Gets or sets a list of properties to return with the query results.
	SelectedRefiners	Gets or sets a list of refiners to return with the query results.
	SendContentBeforeQuery	Specifies whether the Data Provider should run the search query after the page contents have been sent to the client.
	SerializeAll	(Inherited from WebPart.)
	SerializedAttachedPropertiesShared	(Inherited from WebPart.)
	SerializedAttachedPropertiesUser	(Inherited from WebPart.)
	ServerIncludeScripts	Gets or sets the list of scripts to be included by the server Web Part. (Inherited from ScriptWebPart.)
	ServerIncludeScriptsJson	(Inherited from ScriptWebPart.)
	ServerRelativeClassResourcePath	(Inherited from WebPart.)
	ShouldValidate	(Inherited from WebPart.)
	ShowDataErrors	(Inherited from ScriptWebPart.)
	Site	(Inherited from Control.)
	SkinID	(Inherited from WebControl.)
	SourceID	Specifies the source ID of the query.
	SourceLevel	Specifies the source level of the query.
	SourceName	Specifies the source name of the query.
	States	Gets or sets the custom states passed as-is to the control. (Inherited from ScriptWebPart.)
	StatesJson	(Inherited from ScriptWebPart.)
	StorageKey	(Inherited from WebPart.)
	Style	(Inherited from WebControl.)
	Subtitle	(Inherited from WebPart.)
	SummaryLength	Specifies the length of the search result summary. The default value is 180 characters.
	SupportsDisabledAttribute	(Inherited from Panel.)
	SuppressWebPartChrome	(Inherited from WebPart.)
	TabIndex	(Inherited from WebControl.)
	TagKey	(Inherited from WebControl.)
	TagName	(Inherited from WebControl.)
	TemplateControl	(Inherited from Control.)
	TemplateSourceDirectory	(Inherited from Control.)
	Title	(Inherited from WebPart.)
	TitleIconImageUrl	(Inherited from WebPart.)
	TitleUrl	(Inherited from WebPart.)
	ToolTip	(Inherited from WebControl.)
	TrimDuplicates	Gets or sets a Boolean value that specifies whether duplicate items should be removed from the search results.
	UniqueID	(Inherited from Control.)
	UnknownXmlElements	(Inherited from WebPart.)
	UpdateAjaxNavigate	Specifies if the Script Web Part should use client side navigation.
	UseDefaultStyles	(Inherited from WebPart.)
	Verbs	(Inherited from WebPart.)
	ViewState	(Inherited from Control.)
	ViewStateIgnoresCase	(Inherited from Control.)
	ViewStateMode	(Inherited from Control.)
	Visible	(Inherited from Control.)
	WebBrowsableObject	(Inherited from WebPart.)
	WebPartManager	(Inherited from WebPart.)
	WebPartMenu	(Inherited from WebPart.)
	Width	(Inherited from WebPart.)
	WorkItemTimeout	Obsolete. (Inherited from WebPart.)
	Wrap	(Inherited from Panel.)
	Zone	(Inherited from WebPart.)
	ZoneID	(Inherited from WebPart.)
	ZoneIndex	(Inherited from WebPart.)

Top

Methods

	Name	Description
	AddAttributesToRender	(Inherited from Panel.)
	AddedControl	(Inherited from Control.)
	AddNoScriptWarningMessage	(Inherited from ScriptWebPart.)
	AddParsedSubObject	(Inherited from WebPart.)
	AfterDeserialize	(Inherited from WebPart.)
	ApplyStyle	(Inherited from WebControl.)
	ApplyStyleSheetSkin	(Inherited from Control.)
	BuildProfileTree	(Inherited from Control.)
	CanRunAt	Obsolete. (Inherited from WebPart.)
	ClearCachedClientID	(Inherited from Control.)
	ClearChildControlState	(Inherited from Control.)
	ClearChildState	(Inherited from Control.)
	ClearChildViewState	(Inherited from Control.)
	ClearEffectiveClientIDMode	(Inherited from Control.)
	CopyBaseAttributes	(Inherited from WebControl.)
	CreateChildControls	(Inherited from Control.)
	CreateControlCollection	(Inherited from Control.)
	CreateControlStyle	(Inherited from Panel.)
	CreateEditorParts	(Inherited from WebPart.)
	CreateWebPartMenu	(Inherited from WebPart.)
	DataBind()	(Inherited from Part.)
	DataBind(Boolean)	(Inherited from Control.)
	DataBindChildren	(Inherited from Control.)
	Dispose	(Inherited from WebPart.)
	EnsureChildControls	(Inherited from Control.)
	EnsureID	(Inherited from Control.)
	EnsureInterfaces	Obsolete. (Inherited from WebPart.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	FindControl(String)	(Inherited from Control.)
	FindControl(String, Int32)	(Inherited from Control.)
	Focus	(Inherited from Control.)
	GetCustomBuilder	(Inherited from WebPart.)
	GetData	Obsolete. (Inherited from WebPart.)
	GetDesignModeState	(Inherited from Control.)
	GetDesignTimeFooter	(Inherited from WebPart.)
	GetDesignTimeHeader	(Inherited from WebPart.)
	GetHashCode	(Inherited from Object.)
	GetInitEventArgs	Obsolete. (Inherited from WebPart.)
	GetRequiresData	Obsolete. (Inherited from WebPart.)
	GetRouteUrl(Object)	(Inherited from Control.)
	GetRouteUrl(RouteValueDictionary)	(Inherited from Control.)
	GetRouteUrl(String, Object)	(Inherited from Control.)
	GetRouteUrl(String, RouteValueDictionary)	(Inherited from Control.)
	GetScriptDescriptors	(Inherited from ScriptWebPart.)
	GetScriptReferences	(Inherited from ScriptWebPart.)
	GetThemedImages	(Inherited from ScriptWebPart.)
	GetThemedLocalizedImages	(Inherited from WebPart.)
	GetToolParts	(Inherited from WebPart.)
	GetType	(Inherited from Object.)
	GetUniqueIDRelativeTo	(Inherited from Control.)
	HasControls	(Inherited from Control.)
	HasEvents	(Inherited from Control.)
	IsLiteralContent	(Inherited from Control.)
	IsTemplateLocationValid	(Inherited from ScriptWebPart.)
	LoadControlState	(Inherited from Control.)
	LoadResource	(Inherited from ScriptWebPart.)
	LoadViewState	(Inherited from WebPart.)
	MapPathSecure	(Inherited from Control.)
	MemberwiseClone	(Inherited from Object.)
	MergeStyle	(Inherited from WebControl.)
	NotifyWorkItemComplete	Obsolete. (Inherited from WebPart.)
	OnAfterSerializeToClient	(Inherited from ScriptWebPart.)
	OnBeforeSerializeToClient	(Inherited from ScriptWebPart.)
	OnBubbleEvent	(Inherited from Control.)
	OnClosing	(Inherited from WebPart.)
	OnConnectModeChanged	(Inherited from WebPart.)
	OnDataBinding	(Inherited from WebPart.)
	OnDeleting	(Inherited from WebPart.)
	OnEditModeChanged	(Inherited from WebPart.)
	OnInit	Raises the Init event for the Script Web Part. (Overrides ScriptWebPart.OnInit(EventArgs).)
	OnLoad	Raises the Load event for the Script Web Part. (Overrides ScriptWebPart.OnLoad(EventArgs).)
	OnPreRender	(Inherited from ScriptWebPart.)
	OnUnload	(Inherited from WebPart.)
	OpenFile	(Inherited from Control.)
	PartCacheInvalidate()	(Inherited from WebPart.)
	PartCacheInvalidate(Storage)	(Inherited from WebPart.)
	PartCacheInvalidate(Storage, String)	(Inherited from WebPart.)
	PartCacheRead	(Inherited from WebPart.)
	PartCacheWrite	(Inherited from WebPart.)
	PartCommunicationConnect	Obsolete. (Inherited from WebPart.)
	PartCommunicationInit	Obsolete. (Inherited from WebPart.)
	PartCommunicationMain	Obsolete. (Inherited from WebPart.)
	RaiseBubbleEvent	(Inherited from Control.)
	RegisterFrameworkScript	Registers the JavaScript needed by the search UI framework. (Overrides ScriptWebPart.RegisterFrameworkScript().)
	RegisterInterface(String, String, Int32, ConnectionRunAt, Object, String, String, String)	Obsolete. (Inherited from WebPart.)
	RegisterInterface(String, String, Int32, ConnectionRunAt, Object, String, String, String, Boolean)	Obsolete. (Inherited from WebPart.)
	RegisterTemplateScript	Registers a CSR template script. (Inherited from ScriptWebPart.)
	RegisterWorkItem	Obsolete. (Inherited from WebPart.)
	RegisterWorkItemCallback	Obsolete. (Inherited from WebPart.)
	RemovedControl	(Inherited from Control.)
	Render	Renders the HTML for the control. (Overrides WebPart.Render(HtmlTextWriter).)
	RenderBeginTag	(Inherited from Panel.)
	RenderChildren	(Inherited from Control.)
	RenderContents	(Inherited from WebControl.)
	RenderControl(HtmlTextWriter)	(Inherited from Control.)
	RenderControl(HtmlTextWriter, ControlAdapter)	(Inherited from Control.)
	RenderEndTag	(Inherited from Panel.)
	RenderWebPart	(Overrides ScriptWebPart.RenderWebPart(HtmlTextWriter).)
	RenderWorkItemTimeout	Obsolete. (Inherited from WebPart.)
	ReplaceTokens	(Inherited from WebPart.)
	RequiresWebPartClientScript	(Inherited from ScriptWebPart.)
	ResolveAdapter	(Inherited from Control.)
	ResolveClientUrl	(Inherited from Control.)
	ResolveUrl	(Inherited from Control.)
	SaveControlState	(Inherited from Control.)
	SaveViewState	(Inherited from WebControl.)
	ScriptDeserialize<T>	(Inherited from ScriptWebPart.)
	SetDesignModeState	(Inherited from Control.)
	SetPersonalizationDirty	(Inherited from WebPart.)
	SetRenderMethodDelegate	(Inherited from Control.)
	SetWebPartPageComponent	(Inherited from WebPart.)
	ShouldSerializeAllowConnect	(Inherited from WebPart.)
	ShouldSerializeAllowEdit	(Inherited from WebPart.)
	ShouldSerializeAllowHide	(Inherited from WebPart.)
	ShouldSerializeAllowMinimize	(Inherited from WebPart.)
	ShouldSerializeAllowRemove	(Inherited from WebPart.)
	ShouldSerializeAllowZoneChange	(Inherited from WebPart.)
	ShouldSerializeConnectionID	(Inherited from WebPart.)
	ShouldSerializeConnections	(Inherited from WebPart.)
	ShouldSerializeDescription	(Inherited from WebPart.)
	ShouldSerializeDetailLink	(Inherited from WebPart.)
	ShouldSerializeDir	(Inherited from WebPart.)
	ShouldSerializeExportControlledProperties	(Inherited from WebPart.)
	ShouldSerializeFrameState	(Inherited from WebPart.)
	ShouldSerializeFrameType	(Inherited from WebPart.)
	ShouldSerializeHeight	(Inherited from WebPart.)
	ShouldSerializeHelpLink	(Inherited from WebPart.)
	ShouldSerializeHelpMode	(Inherited from WebPart.)
	ShouldSerializeID	(Inherited from WebPart.)
	ShouldSerializeIsIncluded	(Inherited from WebPart.)
	ShouldSerializeIsIncludedFilter	(Inherited from WebPart.)
	ShouldSerializeIsVisible	(Inherited from WebPart.)
	ShouldSerializeMissingAssembly	(Inherited from WebPart.)
	ShouldSerializePartImageLarge	(Inherited from WebPart.)
	ShouldSerializePartImageSmall	(Inherited from WebPart.)
	ShouldSerializePartOrder	(Inherited from WebPart.)
	ShouldSerializeTitle	(Inherited from WebPart.)
	ShouldSerializeWidth	(Inherited from WebPart.)
	ShouldSerializeZoneID	(Inherited from WebPart.)
	ShowMissingFeatureMessageIfNeeded	(Inherited from ScriptWebPart.)
	ToString	(Inherited from Object.)
	TrackViewState	(Inherited from WebPart.)

Top

Events

	Name	Description
	AfterSerializeToClient	(Inherited from ScriptWebPart.)
	BeforeSerializeToClient	(Inherited from ScriptWebPart.)
	DataBinding	(Inherited from Control.)
	Disposed	(Inherited from Control.)
	Init	(Inherited from Control.)
	Load	(Inherited from Control.)
	PreRender	(Inherited from Control.)
	QueryIssuing	Occurs when initial results are received.
	Unload	(Inherited from Control.)

Top

Explicit interface implementations

	Name	Description
	IParserAccessor.AddParsedSubObject	(Inherited from Control.)
	IControlBuilderAccessor.ControlBuilder	(Inherited from Control.)
	IDataBindingsAccessor.DataBindings	(Inherited from Control.)
	IExpressionsAccessor.Expressions	(Inherited from Control.)
	IAttributeAccessor.GetAttribute	(Inherited from WebPart.)
	IConnectionData.GetData	(Inherited from WebPart.)
	IControlDesignerAccessor.GetDesignModeState	(Inherited from Control.)
	IConnectionData.GetRequiresData	(Inherited from WebPart.)
	IDataBindingsAccessor.HasDataBindings	(Inherited from Control.)
	IExpressionsAccessor.HasExpressions	(Inherited from Control.)
	ICompositeControlDesignerAccessor.RecreateChildControls	(Inherited from Part.)
	IAttributeAccessor.SetAttribute	(Inherited from WebPart.)
	IControlDesignerAccessor.SetDesignModeState	(Inherited from Control.)
	IControlDesignerAccessor.SetOwnerControl	(Inherited from Control.)
	IControlDesignerAccessor.UserData	(Inherited from Control.)

Top

See also

Reference

DataProviderScriptWebPart class

Microsoft.Office.Server.Search.WebControls namespace