ASPxDashboard Members
A Web Dashboard control, which allows you to create new dashboards from scratch and display them to end-users.Constructors
| Name | Description |
|---|---|
| ASPxDashboard() | Initializes a new instance of the ASPxDashboard class. |
Fields
| Name | Description |
|---|---|
| ColorSchemeCarmine static | Contains a string identifying the Carmine color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeCarmineCompact static | Contains a string identifying the Carmine compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeDark static | Contains a string identifying the Dark color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeDarkBlue static | Contains a string identifying the custom Dark Blue color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeDarkBlueCompact static | Contains a string identifying the custom Dark Blue compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeDarkCompact static | Contains a string identifying the Dark compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeDarkMoon static | Contains a string identifying the Dark Moon color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeDarkMoonCompact static | Contains a string identifying the Dark Moon compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeDarkViolet static | Contains a string identifying the Dark Violet color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeDarkVioletCompact static | Contains a string identifying the Dark Violet compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeGreenMist static | Contains a string identifying the Green Mist color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeGreenMistCompact static | Contains a string identifying the Green Mist compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeLight static | Contains a string identifying the Light color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeLightBlue static | Contains a string identifying the custom Light Blue color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeLightBlueCompact static | Contains a string identifying the custom Light Blue compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeLightCompact static | Contains a string identifying the Light compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialBlueDark static | Contains a string identifying the Material Blue Dark color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialBlueDarkCompact static | Contains a string identifying the Material Blue Dark compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialBlueLight static | Contains a string identifying the Material Material Blue color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialBlueLightCompact static | Contains a string identifying the Material Blue Light compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialLimeDark static | Contains a string identifying the Material Lime Dark color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialLimeDarkCompact static | Contains a string identifying the Material Lime Dark compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialLimeLight static | Contains a string identifying the Material Lime Light color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialLimeLightCompact static | Contains a string identifying the Material Lime Light compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialOrangeDark static | Contains a string identifying the Material Orange Dark color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialOrangeDarkCompact static | Contains a string identifying the Material Orange Dark compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialOrangeLight static | Contains a string identifying the Material Orange Light color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialOrangeLightCompact static | Contains a string identifying the Material Orange Light compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialPurpleDark static | Contains a string identifying the Material Purple Dark color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialPurpleDarkCompact static | Contains a string identifying the Material Purple Dark compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialPurpleLight static | Contains a string identifying the Material Purple Light color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialPurpleLightCompact static | Contains a string identifying the Material Purple Light compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialTealDark static | Contains a string identifying the Material Teal Dark compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialTealDarkCompact static | Contains a string identifying the Material Teal Dark compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialTealLight static | Contains a string identifying the Material Teal Light color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeMaterialTealLightCompact static | Contains a string identifying the Material Teal Light compact color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeSoftBlue static | Contains a string identifying the Soft Blue color scheme. Inherited from ASPxWebClientUIControl. |
| ColorSchemeSoftBlueCompact static | Contains a string identifying the Soft Blue compact color scheme. Inherited from ASPxWebClientUIControl. |
Properties
| Name | Description |
|---|---|
| AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl. |
| Adapter protected | Gets the browser-specific adapter for the control. Inherited from Control. |
| AllowCreateNewDashboard | Gets or sets whether an end-user can create new dashboards in the ASPxDashboard. |
| AllowCreateNewJsonConnection | Gets or sets whether an end user can create a JSON data source with a new data connection. |
| AllowExecutingCustomSql | Gets or sets whether to executes SQL queries on the server side. |
| AllowExportDashboard | Gets or sets whether the entire dashboard can be exported by end-users. |
| AllowExportDashboardItems | Gets or sets whether the dashboard items can be exported by end-users. |
| AllowInspectAggregatedData | Gets or sets whether to display aggregated data in the Data Inspector. |
| AllowInspectRawData | Gets or sets whether to display raw data in the Data Inspector. |
| AllowMaximizeItems | Gets or sets whether end users can maximize dashboard items. |
| AllowOpenDashboard | Gets or sets whether an end-user can open existing dashboards in the ASPxDashboard. |
| AllowReadUnlistedColumnsFromClientApi | Gets or sets whether to enable client-side access to data source fields that are not associated with any dashboard item’s data members. |
| AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control. |
| Attributes | Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl. |
| BackColor | Gets or sets the background color of the Web server control. Inherited from WebControl. |
| BackendOptions | Specifies options that allow you to configure the Web Dashboard’s back-end. |
| BackgroundImage | Gets the web control’s background image. Inherited from ASPxWebControl. |
| BackwardCompatibility static | Provides access to the control’s backward compatibility settings. Inherited from ASPxWebControl. |
| Border | Gets the web control’s border settings. Inherited from ASPxWebControl. |
| BorderBottom | Gets the settings of the web control’s bottom border. Inherited from ASPxWebControl. |
| BorderLeft | Gets the settings of the web control’s left border. Inherited from ASPxWebControl. |
| BorderRight | Gets the settings of the web control’s right border. Inherited from ASPxWebControl. |
| BorderTop | Gets the settings of the web control’s top border. Inherited from ASPxWebControl. |
| CanCreateNewJsonDataSource | Obsolete. This property is no longer used. Use AllowCreateNewJsonConnection instead. |
| ChildControlsCreated protected | Gets a value that indicates whether the server control’s child controls have been created. Inherited from Control. |
| ClientID | Gets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase. |
| ClientIDMode | Gets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control. |
| ClientIDSeparator protected | Gets a character value representing the separator character used in the ClientID property. Inherited from Control. |
| ClientInstanceName | Gets or sets the ASPxDashboard‘s client programmatic identifier. |
| ClientSideEvents | Gets an object that lists the client-side events specific to the ASPxDashboard control. |
| ColorScheme | Gets or sets the name of the color theme to be applied to the control. |
| Context protected | Gets the HttpContext object associated with the server control for the current Web request. Inherited from Control. |
| Controls | Gets the web control’s collection of child controls. Inherited from ASPxWebControlBase. |
| ControlStyle | Gets the style of the Web server control. This property is used primarily by control developers. Inherited from WebControl. |
| ControlStyleCreated | Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. Inherited from WebControl. |
| CssClass | Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. Inherited from WebControl. |
| CssFilePath | Gets or sets the path to a CSS file that defines the web control’s appearance. Inherited from ASPxWebControl. |
| CssPostfix | Gets or sets a CSS class name postfix that identifies style settings to be applied to the control. Inherited from ASPxWebControl. |
| Cursor | Gets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl. |
| DashboardId | This property is no longer used. Use InitialDashboardId instead. |
| DashboardState | Allows you to specify the default dashboard state (such as the master filtering state) for the ASPxDashboard‘s. |
| DashboardStorageFolder | Gets or sets the path to a folder used to keep dashboards. |
| DashboardType | Gets or sets a dashboard created at design time within Visual Studio. This property is in effect only when ASPxDashboard acts as Viewer. |
| DashboardXmlPath | Gets or sets the path to the XML definition of a dashboard to be loaded to ASPxDashboard. |
| DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control. |
| DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control. |
| DataRequestOptions | Provides access to options that allow you to configure data request parameters. |
| DataSourceCacheEnabled | Specifies whether the Web Dashboard Control caches its data sources. |
| DisabledCssClass static | Gets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl. |
| DisabledStyle | Gets the style settings which define a control’s appearance in the disabled state. Inherited from ASPxWebControl. |
| DisableHttpHandlerValidation | Specifies whether to disable the HttpHandler validation. Inherited from ASPxWebClientUIControl. |
| EmptyImage static | Obsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl. |
| EnableCustomSql | Enables a user to specify a custom SQL string in the Data Source wizard. |
| Enabled | Gets or sets a value that indicates whether a web control is enabled, allowing it to respond to user interactions. Inherited from ASPxWebControl. |
| EnableDefaultAppearance | Obsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl. |
| EnableFederationDataSource | Gets or sets whether to allow users to create a federated data source in the Dashboard Data Source Wizard. |
| EnableJsonDataSource | Gets or sets whether to allow users to create the JSON data source in the Dashboard Data Source Wizard. |
| EnableOlapDataSource | Gets or sets whether to allow users to create the OLAP data source in the Dashboard Data Source Wizard. |
| EnableSqlDataSource | Gets or sets whether to allow users to create the SQL data source in the Dashboard Data Source Wizard. |
| EnableTextBoxItemEditor | Gets or sets whether to enable an editor for the Text Box item. |
| EnableViewState | Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. Inherited from Control. |
| EncodeHtml | Gets or sets whether to encode editor value and content. Inherited from ASPxWebControl. |
| Events protected | Gets a list of event handler delegates for the control. This property is read-only. Inherited from Control. |
| ExcelExportOptions | Provides access to options related to exporting a dashboard item to Excel format. |
| ExportOptions | Obsolete. Provides access to dashboard options specific to export. |
| Font | Gets the font properties associated with the Web server control. Inherited from WebControl. |
| ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control. Inherited from WebControl. |
| GlobalAccessibilityCompliant static | Gets or sets whether accessibility support is globally enabled for all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl. |
| GlobalCheckReferencesToExternalScripts static | Gets or sets whether links to external client scripts (such as jQuery, Knockout, and others), which are used by some DevExpress web components, are checked for presence and correctness. Inherited from ASPxWebControl. |
| GlobalColorScheme static | Gets or sets the name of the color theme to be globally applied to all DevExpress web controls (that are ASPxWebClientUIControl class descendants) across the entire web site. Inherited from ASPxWebClientUIControl. |
| GlobalEmbedRequiredClientLibraries static | Obsolete. Gets or sets whether external client libraries (including scripts and CSS files) are automatically embedded in the DevExpress.Web assembly as resources. Inherited from ASPxWebControl. |
| GlobalRightToLeft static | Gets or sets that the right-to-left orientation shall be globally applied to all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl. |
| GlobalStyleSheetTheme static | Gets or sets the name of the style sheet theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl. |
| GlobalTheme static | Gets or sets the name of the Theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl. |
| GlobalThemeBaseColor static | Gets or sets the base color for the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl. |
| GlobalThemeFont static | Gets or sets the font settings of the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl. |
| HandleServerErrors static | Gets or sets whether callback exceptions are handled on the server. |
| HasAttributes | Gets a value indicating whether the control has attributes set. Inherited from WebControl. |
| HasChildViewState protected | Gets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control. |
| Height | Gets or sets the height of the web server control. Inherited from ASPxWebControl. |
| ID | Gets or sets the programmatic identifier assigned to the server control. Inherited from Control. |
| IdSeparator protected | Gets the character used to separate control identifiers. Inherited from Control. |
| ImageExportOptions | Provides access to options related to exporting a dashboard/dashboard item to an image. |
| IncludeDashboardIdToUrl | Gets or sets whether the ASPxDashboard.DashboardId is included in the ASPxDashboard‘s URL. |
| IncludeDashboardStateToUrl | Gets or sets whether the dashboard state (such as the master filtering state) will be included in the ASPxDashboard‘s URL. |
| InitialDashboardId | Gets or sets the identifier of the dashboard to be loaded to ASPxDashboard. |
| InitialDashboardState | Gets or sets the initial dashboard state when loading a dashboard. |
| Initialized | Gets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase. |
| IsCallback | Gets a value indicating whether the request is the result of a callback sent by the control. Inherited from ASPxWebControl. |
| IsChildControlStateCleared protected | Gets a value indicating whether controls contained within this control have control state. Inherited from Control. |
| IsTrackingViewState protected | Gets a value that indicates whether the server control is saving changes to its view state. Inherited from Control. |
| IsViewStateEnabled protected | Gets a value indicating whether view state is enabled for this control. Inherited from Control. |
| JSProperties | Gets a collection of temporary client properties and their values. |
| LimitVisibleDataMode | Gets or sets a data limitation mode that allows you to display a reduced form of visible data. |
| LoadDefaultDashboard | Gets or sets whether the default dashboard should be loaded from the dashboard storage. |
| Loaded | Indicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase. |
| LoadViewStateByID protected | Gets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control. |
| MobileLayoutEnabled | Gets or sets a mobile layout mode for the Web Dashboard. |
| NamingContainer | Gets a reference to the server control’s naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. Inherited from Control. |
| Nonce | Specifies the nonce value. |
| Page | Gets a reference to the Page instance that contains the server control. Inherited from Control. |
| Parent | Gets a reference to the server control’s parent control in the page control hierarchy. Inherited from Control. |
| ParentImages | This property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl. |
| ParentStyles | This property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl. |
| PdfExportOptions | Provides access to options related to exporting a dashboard/dashboard item to PDF format. |
| RegisterDevExtremeFontHandler static | For internal use only. Inherited from ASPxWebClientUIControl. |
| RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control. |
| ResizeByTimer | Gets or sets whether to redraw the Web Dashboard control when the size of a container is changed. |
| ServiceContainer | For internal use. |
| ShadowImage static | Obsolete. Gets the shadow image properties. Inherited from ASPxWebControl. |
| ShowConfirmationOnBrowserClosing | Gets or sets whether the web browser displays a confirmation message when an-end user closes a page containing the Web Dashboard. |
| Site | Gets information about the container that hosts the current control when rendered on a design surface. Inherited from Control. |
| SkinID | Gets or sets the skin to apply to the control. Inherited from WebControl. |
| Style | Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. Inherited from WebControl. |
| SupportsDisabledAttribute |
Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to “disabled” when the control’s IsEnabled property is false.
Inherited from WebControl. |
| IControlBuilderAccessor.ControlBuilder | For a description of this member, see ControlBuilder. Inherited from Control. |
| IControlDesignerAccessor.UserData | For a description of this member, see UserData. Inherited from Control. |
| IDataBindingsAccessor.DataBindings | For a description of this member, see DataBindings. Inherited from Control. |
| IDataBindingsAccessor.HasDataBindings | For a description of this member, see HasDataBindings. Inherited from Control. |
| IExpressionsAccessor.Expressions | For a description of this member, see Expressions. Inherited from Control. |
| IExpressionsAccessor.HasExpressions | For a description of this member, see HasExpressions. Inherited from Control. |
| TabIndex | Gets or sets the tab index of the Web server control. Inherited from WebControl. |
| TagName protected | Gets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl. |
| TemplateControl | Gets or sets a reference to the template that contains this control. Inherited from Control. |
| TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control. |
| ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. Inherited from WebControl. |
| UniqueID | Gets the unique, hierarchically qualified identifier for the server control. Inherited from Control. |
| UseCardLegacyLayout | Gets or sets whether to enable the legacy card layout used prior to v17.1. |
| UseDashboardConfigurator | Gets or sets whether the ASPxDashboard control uses the server-side API provided by DashboardConfigurator. |
| UseDevExtremeFontHandler static | Specifies whether DevExtreme fonts and images are used. Inherited from ASPxWebClientUIControl. |
| UseNeutralFilterMode | Gets or sets whether to show all items in the filter elements deselected by default. |
| ValidateRequestMode | Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control. |
| ViewState protected | Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. Inherited from Control. |
| ViewStateIgnoresCase protected | Gets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control. |
| ViewStateMode | Gets or sets the view-state mode of this control. Inherited from Control. |
| Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page. Inherited from Control. |
| Width | Gets or sets the width of the web server control. Inherited from ASPxWebControl. |
| WorkingMode | Gets or sets a working mode of the ASPxDashboard control. |
Methods
| Name | Description |
|---|---|
| AddAttributesToRender(HtmlTextWriter) protected | Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. Inherited from WebControl. |
| AddedControl(Control, Int32) protected | Called after a child control is added to the Controls collection of the Control object. Inherited from Control. |
| AddParsedSubObject(Object) protected | Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control’s ControlCollection object. Inherited from Control. |
| ApplyStyle(Style) | Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. Inherited from WebControl. |
| ApplyStyleSheetSkin(Page) | Applies the style properties defined in the page style sheet to the control. Inherited from Control. |
| BeginRenderTracing(TextWriter, Object) protected | Begins design-time tracing of rendering data. Inherited from Control. |
| BuildProfileTree(String, Boolean) protected | Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. Inherited from Control. |
| ClearCachedClientID() protected |
Sets the cached ClientID value to null.
Inherited from Control. |
| ClearChildControlState() protected | Deletes the control-state information for the server control’s child controls. Inherited from Control. |
| ClearChildState() protected | Deletes the view-state and control-state information for all the server control’s child controls. Inherited from Control. |
| ClearChildViewState() protected | Deletes the view-state information for all the server control’s child controls. Inherited from Control. |
| ClearEffectiveClientIDMode() protected | Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. Inherited from Control. |
| CopyBaseAttributes(WebControl) | Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. Inherited from WebControl. |
| CreateControlCollection() protected | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. Inherited from Control. |
| DataBind() | Binds the data source to the invoked server control. Inherited from ASPxWebControl. |
| DataBind(Boolean) protected | Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. Inherited from Control. |
| DataBindChildren() protected | Binds a data source to the server control’s child controls. Inherited from Control. |
| Dispose() | Enables a server control to perform final clean up before it is released from memory. |
| EndRenderTracing(TextWriter, Object) protected | Ends design-time tracing of rendering data. Inherited from Control. |
| EnsureID() protected | Creates an identifier for controls that do not have an identifier assigned. Inherited from Control. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| FindControl(String, Int32) protected |
Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.
Inherited from Control. |
| FindControl(String) |
Searches the current naming container for a server control with the specified id parameter.
Inherited from Control. |
| Focus() | Sets input focus to the web control. Inherited from ASPxWebControl. |
| GetCallbackErrorMessage() static | Obtains the error info while processing the redirection page. Inherited from ASPxWebControl. |
| GetClientLocalizedStrings() static | |
| GetClientSideEventHandler(String) | Returns the specified client event’s handler. Inherited from ASPxWebControl. |
| GetCssClassNamePrefix() | For internal use only. Inherited from ASPxWebControl. |
| GetCssClassNamePrefix(String) | For internal use only. Inherited from ASPxWebControl. |
| GetDefaultBooleanProperty(String, DefaultBoolean) | For internal use only. Inherited from ASPxWebControl. |
| GetDesignModeState() protected | Gets design-time data for a control. Inherited from Control. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetResourceUrl(Page, String) static | Returns a URL reference to an embedded resource in an assembly. Inherited from ASPxWebControl. |
| GetResourceUrl(Page, Type, String) static | Returns a URL reference to an embedded resource in an assembly. Inherited from ASPxWebControl. |
| GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. Inherited from Control. |
| GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control. |
| GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control. |
| GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. Inherited from Control. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| GetUniqueIDRelativeTo(Control) | Returns the prefixed portion of the UniqueID property of the specified control. Inherited from Control. |
| HasControls() | Determines if the server control contains any child controls. Inherited from Control. |
| HasEvents() protected | Returns a value indicating whether events are registered for the control or any child controls. Inherited from Control. |
| HtmlEncode(String, Boolean) | For internal use only. Inherited from ASPxWebControl. |
| HtmlEncode(String) | For internal use only. Inherited from ASPxWebControl. |
| IsAccessibilityCompliantRender() | Returns a value that indicates whether the control’s accessible html code is rendered. Inherited from ASPxWebControl. |
| IsAccessibilityCompliantRender(Boolean) | Returns a value that indicates whether the control’s accessible html code is rendered. Inherited from ASPxWebControl. |
| IsClientSideAPIEnabled() | Returns a value that indicates whether a specific programmatic interface (in particular, specific JavaScript objects and methods) are available to the control on the client side. Inherited from ASPxWebControl. |
| IsEnabled() | Returns a value that specifies whether a web control is enabled. Inherited from ASPxWebControlBase. |
| IsLiteralContent() protected | Determines if the server control holds only literal content. Inherited from Control. |
| IsLoading() | This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from ASPxWebControl. |
| IsVisible() | Returns a value that specifies whether the current web control is displayed. Inherited from ASPxWebControlBase. |
| LoadControlState(Object) protected | Restores control-state information from a previous page request that was saved by the SaveControlState() method. Inherited from Control. |
| MakeResponseCompressed() static | Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client. Inherited from ASPxWebControl. |
| MakeResponseCompressed(Boolean) static | Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client, and accepts a parameter specifying whether to apply compression to IE6. Inherited from ASPxWebControl. |
| MapPathSecure(String) protected | Retrieves the physical path that a virtual path, either absolute or relative, maps to. Inherited from Control. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MergeStyle(Style) | Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. Inherited from WebControl. |
| OnBubbleEvent(Object, EventArgs) protected | Determines whether the event for the server control is passed up the page’s UI server control hierarchy. Inherited from Control. |
| OnDataBinding(EventArgs) protected | Raises the DataBinding event. Inherited from Control. |
| OnUnload(EventArgs) protected | Raises the Unload event. Inherited from Control. |
| OpenDashboard(String) | Loads a dashboard from a string containing a dashboard XML definition. |
| OpenDashboard(XDocument) | Loads a dashboard from a document containing a dashboard XML definition. |
| OpenFile(String) protected | Gets a Stream used to read a file. Inherited from Control. |
| RaiseBubbleEvent(Object, EventArgs) protected | Assigns any sources of the event and its information to the control’s parent. Inherited from Control. |
| RedirectOnCallback(String) static | Redirects a client to a new URL while processing a callback. Inherited from ASPxWebControl. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| RegisterBaseScript(Page, Boolean) static | Registers base scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl. |
| RegisterBaseScript(Page) static | Registers base scripts, required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl. |
| RegisterUtilsScript(Page) static | Obsolete. Registers utils scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl. |
| RemovedControl(Control) protected | Called after a child control is removed from the Controls collection of the Control object. Inherited from Control. |
| RenderBeginTag(HtmlTextWriter) | Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl. |
| RenderChildren(HtmlTextWriter) protected | Outputs the content of a server control’s children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. Inherited from Control. |
| RenderContents(HtmlTextWriter) protected | Renders the contents of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl. |
| RenderControl(HtmlTextWriter, ControlAdapter) protected | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. Inherited from Control. |
| RenderControl(HtmlTextWriter) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. Inherited from Control. |
| RenderEndTag(HtmlTextWriter) | Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. Inherited from WebControl. |
| RequireClientLibrariesRegistering() static | Specifies whether client library registration is required. Inherited from ASPxWebControl. |
| ResolveAdapter() protected | Gets the control adapter responsible for rendering the specified control. Inherited from Control. |
| ResolveClientUrl(String) | Gets a URL that can be used by the browser. Inherited from ASPxWebControlBase. |
| ResolveUrl(String) | Converts a URL into one that is usable on the requesting client. Inherited from Control. |
| SaveControlState() protected | Saves any server control state changes that have occurred since the time the page was posted back to the server. Inherited from Control. |
| SetCallbackErrorMessage(String) static | Specifies the message text to be displayed for remote clients when a DevExpress control callback error has occurred. Inherited from ASPxWebControl. |
| SetClientSideEventHandler(String, String) | Defines a handler for the specified client event. Inherited from ASPxWebControl. |
| SetConnectionStringsProvider(IDataSourceWizardConnectionStringsStorage) | Specifies a provider of data connections that can be used by the Web Dashboard. |
| SetConnectionStringsProvider(IDataSourceWizardConnectionStringsProvider) | Specifies a provider of data connections that can be used by the Web Dashboard. |
| SetDashboardStorage(IDashboardStorage) | Specifies a custom storage of dashboards for the Web Dashboard. |
| SetDataSourceStorage(IDataSourceStorage) | Specifies a data source storage for the Web Dashboard. |
| SetDBCommandInterceptor(IDBCommandInterceptor) |
Registers IDBCommandInterceptor in ASPxDashboard.
|
| SetDBConnectionInterceptor(IDBConnectionInterceptor) |
Registers IDBConnectionInterceptor in ASPxDashboard.
|
| SetDBSchemaProvider(IDBSchemaProvider) | Specifies a custom data store schema. |
| SetDBSchemaProvider(IDBSchemaProviderEx) | Specifies a database schema provider for the Web Dashboard. |
| SetDesignModeState(IDictionary) protected | Sets design-time data for a control. Inherited from Control. |
| SetRenderMethodDelegate(RenderMethod) | Assigns an event handler delegate to render the server control and its content into its parent control. Inherited from Control. |
| SetTraceData(Object, Object, Object) | Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. Inherited from Control. |
| SetTraceData(Object, Object) | Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. Inherited from Control. |
| StaticInitialize() static | Initializes an HTTP handler module for the ASPxDashboard control. |
| IAttributeAccessor.GetAttribute(String) | Gets an attribute of the Web control with the specified name. Inherited from WebControl. |
| IAttributeAccessor.SetAttribute(String, String) | Sets an attribute of the Web control to the specified name and value. Inherited from WebControl. |
| IControlDesignerAccessor.GetDesignModeState() | For a description of this member, see GetDesignModeState(). Inherited from Control. |
| IControlDesignerAccessor.SetDesignModeState(IDictionary) | For a description of this member, see SetDesignModeState(IDictionary). Inherited from Control. |
| IControlDesignerAccessor.SetOwnerControl(Control) | For a description of this member, see SetOwnerControl(Control). Inherited from Control. |
| IParserAccessor.AddParsedSubObject(Object) | For a description of this member, see AddParsedSubObject(Object). Inherited from Control. |
| ToString() | Returns a string that represents the current object. Inherited from Object. |
Events
| Name | Description |
|---|---|
| BeforeExportDocument | Allows you to hide specific dashboard items when exporting the entire dashboard. |
| CallbackError static | Allows you to handle any server exception that might occur during server-side processing of a callback sent by a DevExpress web control. Inherited from ASPxWebControl. |
| ConfigureDataConnection | Allows you to customize connection settings before the ASPxDashboard connects to a data store (database, OLAP cube, etc.). |
| ConfigureDataReloadingTimeout | Allows you to set a time interval that specifies how frequently the Web Dashboard should refill its in-memory cache when a user sends a data request. |
| ConfigureItemDataCalculation | Allows you to configure how the dashboard item’s client data is calculated. |
| ConnectionError | Allows you to override the default behavior if data store connection fails with current connection parameters. |
| CustomAssemblyLoading | Occurs before a custom assembly is loaded for use as DashboardEFDataSource. |
| CustomDataCallback | Fires when a round trip to the server has been initiated by a call to the client ASPxClientDashboard.PerformDataCallback method. |
| CustomExport | Allows you to customize the exported document. |
| CustomFilterExpression | Allows you to include WHERE clauses into DashboardSqlDataSource queries. |
| CustomizeExportDocument | Allows you to customize the stream containing the resulting document (such as PDF, Image, or Excel). |
| CustomJSProperties | Enables you to supply any server data that can then be parsed on the client. |
| CustomPalette | Provides the capability to substitute the default palette containing colors used to paint dashboard item elements. |
| CustomParameters | Occurs before data is loaded from the data store and allows you to change parameter values before they are passed to a data query. |
| DashboardAdding | Allows you to add a new dashboard to the dashboard storage at runtime. |
| DashboardLoading | Allows you to load a dashboard at runtime. |
| DashboardSaving | Allows you to save a dashboard at runtime. |
| DataBinding | Occurs when the server control binds to a data source. Inherited from Control. |
| DataLoading | Allows you to provide data for the DashboardObjectDataSource. |
| DataSourceCacheKeyCreated | Occurs when a data source cache key is created. Allows you to manage cache granularity. |
| Disposed | Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. Inherited from Control. |
| ExcelDataSourceBeforeFill | Provides the capability to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files. |
| Init | Occurs when the server control is initialized, which is the first step in its lifecycle. Inherited from Control. |
| Load | Occurs when the server control is loaded into the Page object. Inherited from Control. |
| PreRender | Occurs after the Control object is loaded but prior to rendering. Inherited from Control. |
| RequestDashboardIDs | Allows you to specify dashboards available in the dashboard storage. |
| SetInitialDashboardState | Allows you to specify the initial dashboard state when loading a dashboard. |
| Unload | Occurs when the server control is unloaded from memory. Inherited from Control. |
| ValidateDashboardCustomSqlQuery | Provides the capability to check the validity of the custom SQL query used to supply the dashboard with data. |
| ValidateUnderlyingDataColumns | Raises when a user requests underlying data from the client and allows you to validate which columns should be returned. |
See Also