Export (0) Print
Expand All

DataProviderScriptWebPart members

SharePoint 2013

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

The DataProviderScriptWebPart type exposes the following members.

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

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

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

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

Community Additions

ADD
Show:
© 2014 Microsoft