DataProviderScriptWebPart properties
SharePoint 2013
The DataProviderScriptWebPart type exposes the following members.
| Name | Description | |
|---|---|---|
|
AccessKey | (Inherited from WebControl.) |
|
|
Active | Data provider is only active if it belongs to the query group of its choice. It may not because another data provider with the same query group name was chosen over the current one. |
|
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 | Tracks if 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 | Tracks if 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 | |
|
|
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 | Client type which issues queries. |
|
|
CollapseSpecification | 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 | 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 | |
|
|
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 | If true, substrate result table will interleave different result sets based query rules |
|
|
EnableNicknames | If true, nickname expansion will be enabled on the current query |
|
|
EnableOrderingHitHighlightedProperty | |
|
|
EnablePhonetic | If true, phonetic name expansion will be enabled on the current query |
|
|
EnableQueryRules | |
|
|
EnableStemming | If true, stemming will be 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 | If set, this property is the language fall back for all queries issued by this data provider |
|
|
FallbackRankingModelID | If set, this property is the ranking model fall back for all queries issued by this data provider |
|
|
FallbackRefinementFilters | A set of refinement filters to fallback to. |
|
|
FallbackSort | If set, this property is the sort fall back for all queries issued by this data provider |
|
|
FallbackSortJson | Temporary property till toolpart is implemented. TODO: Remove when proper toolpart is implemented |
|
|
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 | |
|
|
HitHighlightedProperties | List of properties to hit highlight on |
|
|
HorizontalAlign | (Inherited from Panel.) |
|
|
ID | (Inherited from WebPart.) |
|
|
IdSeparator | (Inherited from Control.) |
|
|
IgnoreContextualScope | |
|
|
IgnoreQueryPropertiesTemplateUrl | The default value (false) is different than the default value of Query.IgnoreQueryPropertiesTemplateUrl because unlike arbitrary callers of the Query class, the DataProviderScriptWebPart explicitly sets a value for QueryPropertiesTemplateUrl. |
|
|
IgnoreStaleServerQuery | |
|
|
ImportErrorMessage | (Inherited from WebPart.) |
|
|
InitialQueryState | Initial query state to use in the absence of user specified query state. |
|
|
InitialResult | Results of the intial query, if data provider is synchronous and active. Empty otherwise. |
|
|
InitialResultRef | Variable name of the results of the intial query, if data provider is synchronous and active. Empty otherwise. This value is populated when the request is flushed before the query is made |
|
|
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 | Specify 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 | |
|
|
ProcessBestBets | |
|
|
ProcessPersonalFavorites | |
|
|
Properties | The property bag for user defined basic type properties |
|
|
PropertiesJson | The JSON version of Properties |
|
|
Qualifier | (Inherited from WebPart.) |
|
|
QueryGroupName | The query group ID. |
|
|
QueryPropertiesTemplateUrl | The QueryPropertiesTemplate URL to use for queries from this data provider. |
|
|
QueryTemplate | The query template |
|
|
RankRules | If set, this property is a set of rank rules applied for all queries issued by this data provider |
|
|
RankRulesJson | Property to set reordering rules from web page |
|
|
RenderingCompatibility | (Inherited from Control.) |
|
|
RenderTemplateId | Gets or sets the control render template name. (Inherited from ScriptWebPart.) |
|
|
ResultsPerPage | Number of results to display per page. |
|
|
SaveProperties | (Inherited from WebPart.) |
|
|
ScopeResultsToCurrentSite | |
|
|
ScriptSerializer | (Inherited from ScriptWebPart.) |
|
|
ScrollBars | (Inherited from Panel.) |
|
|
SelectedProperties | List of properties to return with query results |
|
|
SelectedRefiners | List of refiners to return with query results |
|
|
SendContentBeforeQuery | Tracks if data provider should perform the search query after the page contents have been send to the client. This property is ignored if AsynchronousResultRetrieval is set to true, the page where the provider is running doesn't support it, of if the contents are being rendered at the server side |
|
|
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 | The query source ID. |
|
|
SourceLevel | The query source level. |
|
|
SourceName | The query source name. |
|
|
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 | |
|
|
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 | If true, duplicate results will be removed for the current query |
|
|
UniqueID | (Inherited from Control.) |
|
|
UnknownXmlElements | (Inherited from WebPart.) |
|
|
UpdateAjaxNavigate | |
|
|
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.) |
| Name | Description | |
|---|---|---|
|
IControlBuilderAccessor.ControlBuilder | (Inherited from Control.) |
|
|
IDataBindingsAccessor.DataBindings | (Inherited from Control.) |
|
|
IExpressionsAccessor.Expressions | (Inherited from Control.) |
|
|
IDataBindingsAccessor.HasDataBindings | (Inherited from Control.) |
|
|
IExpressionsAccessor.HasExpressions | (Inherited from Control.) |
|
|
IControlDesignerAccessor.UserData | (Inherited from Control.) |
