dashboard-devexpress-dot-dashboardweb-dot-aspxdashboard-dot-underscore-properties.md
A Web Dashboard control, which allows you to create new dashboards from scratch and display them to end-users.
| 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. |
| EnableMongoDBDataSource | Gets or sets whether to allow users to create a MongoDB 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. |
See Also