MVCxDashboard Members

Constructors

Name Description
MVCxDashboard()

Initializes a new instance of the MVCxDashboard class.

Properties

Name Description
AllowCreateNewDashboard

Gets or sets whether or not an end-user can create new dashboards in the ASPxDashboard.

(Inherited from ASPxDashboard)
AllowExecutingCustomSql

Gets or sets whether to executes SQL queries on the server side.

(Inherited from ASPxDashboard)
AllowExportDashboard

Gets or sets whether the entire dashboard can be exported by end-users.

(Inherited from ASPxDashboard)
AllowExportDashboardItems

Gets or sets whether the dashboard items can be exported by end-users.

(Inherited from ASPxDashboard)
AllowMaximizeItems

Gets or sets whether end users can maximize dashboard items.

(Inherited from ASPxDashboard)
AllowOpenDashboard

Gets or sets whether or not an end-user can open existing dashboards in the ASPxDashboard.

(Inherited from ASPxDashboard)
BackendOptions

Specifies options that allow you to configure the Web Dashboard's back-end.

(Inherited from ASPxDashboard)
ClientInstanceName

Gets or sets the ASPxDashboard's client programmatic identifier.

(Inherited from ASPxDashboard)
ClientSideEvents

Gets an object that lists the client-side events specific to the ASPxDashboard control.

(Inherited from ASPxDashboard)
ColorScheme

Gets or sets the name of the color theme to be applied to the control.

(Inherited from ASPxDashboard)
ControllerName

Gets or sets the controller name.

DashboardId

Gets or sets the dashboard identifier.

(Inherited from ASPxDashboard)
DashboardState

Allows you to specify the default dashboard state (such as the master filtering state) for the ASPxDashboard's.

(Inherited from ASPxDashboard)
DashboardStorageFolder

Gets or sets the path to a folder used to keep dashboards.

(Inherited from ASPxDashboard)
DashboardType

Gets or sets the type of a dashboard to be displayed in the ASPxDashboard.

(Inherited from ASPxDashboard)
DashboardXmlPath

Gets or sets the path to the XML definition of a dashboard to be loaded to ASPxDashboard.

(Inherited from ASPxDashboard)
EnableCustomSql

Enables a user to specify a custom SQL string in the Data Source wizard.

(Inherited from ASPxDashboard)
ExcelExportOptions

Provides access to options related to exporting a dashboard item to the Excel format.

(Inherited from ASPxDashboard)
ExportOptions

Obsolete. Provides access to dashboard options specific to export.

(Inherited from ASPxDashboard)
HandleServerErrors

Gets or sets whether or not callback exceptions are handled on the server.

(Inherited from ASPxDashboard)
ImageExportOptions

Provides access to options related to exporting a dashboard/dashboard item to an image.

(Inherited from ASPxDashboard)
IncludeDashboardIdToUrl

Gets or sets whether the ASPxDashboard.DashboardId is included in the ASPxDashboard's URL.

(Inherited from ASPxDashboard)
IncludeDashboardStateToUrl

Gets or sets whether or not the dashboard state (such as the master filtering state) will be included in the ASPxDashboard's URL.

(Inherited from ASPxDashboard)
InitialDashboardId

Gets or sets the identifier of the dashboard to be loaded to ASPxDashboard.

(Inherited from ASPxDashboard)
InitialDashboardState

Gets or sets the initial dashboard state when loading a dashboard.

(Inherited from ASPxDashboard)
JSProperties

Gets a collection of temporary client properties and their values.

(Inherited from ASPxDashboard)
LimitVisibleDataMode

Gets or sets a data limitation mode that allows you to display a reduced form of visible data.

(Inherited from ASPxDashboard)
LoadDefaultDashboard

Gets or sets whether or not the default dashboard should be loaded from the dashboard storage.

(Inherited from ASPxDashboard)
MobileLayoutEnabled

Gets or sets a mobile layout mode for the Web Dashboard.

(Inherited from ASPxDashboard)
PdfExportOptions

Provides access to options related to exporting a dashboard/dashboard item to the PDF format.

(Inherited from ASPxDashboard)
ResizeByTimer
(Inherited from ASPxDashboard)
ServiceContainer

For internal use.

(Inherited from ASPxDashboard)
ShowConfirmationOnBrowserClosing

Gets or sets whether or not the web browser displays a confirmation message when an-end user closes a page containing the Web Dashboard.

(Inherited from ASPxDashboard)
UseCardLegacyLayout

Gets or sets whether to enable the legacy card layout used prior to v17.1.

(Inherited from ASPxDashboard)
UseDashboardConfigurator

Gets or sets whether or not the ASPxDashboard control uses the server-side API provided by DashboardConfigurator.

(Inherited from ASPxDashboard)
UseNeutralFilterMode

Gets or sets whether to show all items in the filter elements deselected by default.

(Inherited from ASPxDashboard)
WorkingMode

Gets or sets a working mode of the ASPxDashboard control.

(Inherited from ASPxDashboard)

Methods

Name Description
Dispose()

Enables a server control to perform final clean up before it is released from memory.

(Inherited from ASPxDashboard)
GetClientLocalizedStrings()
(Inherited from ASPxDashboard)
OpenDashboard(String)

Loads a dashboard from a string containing a dashboard XML definition.

(Inherited from ASPxDashboard)
OpenDashboard(XDocument)

Loads a dashboard from a document containing a dashboard XML definition.

(Inherited from ASPxDashboard)
SetConnectionStringsProvider(IDataSourceWizardConnectionStringsProvider)

Specifies a provider of data connections that can be used by the Web Dashboard.

(Inherited from ASPxDashboard)
SetDBSchemaProvider(IDBSchemaProvider)

Specifies a custom data store schema.

(Inherited from ASPxDashboard)
SetDBSchemaProvider(IDBSchemaProviderEx)

Specifies a custom data store schema.

(Inherited from ASPxDashboard)
SetDashboardStorage(IDashboardStorage)

Specifies a custom storage of dashboards for the Web Dashboard.

(Inherited from ASPxDashboard)
SetDataSourceStorage(IDataSourceStorage)

Specifies a data source storage for the Web Dashboard.

(Inherited from ASPxDashboard)
StaticInitialize()

Initializes an HTTP handler module for the ASPxDashboard control.

(Inherited from ASPxDashboard)

Events

Name Description
BeforeExportDocument

Allows you to hide specific dashboard items when exporting the entire dashboard.

(Inherited from ASPxDashboard)
ConfigureDataConnection

Allows you to customize connection settings before the ASPxDashboard connects to a data store (database, OLAP cube, etc.).

(Inherited from ASPxDashboard)
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.

(Inherited from ASPxDashboard)
ConfigureItemDataCalculation

Allows you to configure how the dashboard item's client data is calculated.

(Inherited from ASPxDashboard)
ConnectionError

Allows overriding the default behavior when current connection parameters do not allow connecting to a data store.

(Inherited from ASPxDashboard)
CustomAssemblyLoading

Occurs before a custom assembly is loaded for use as DashboardEFDataSource.

(Inherited from ASPxDashboard)
CustomDataCallback

Fires when a round trip to the server has been initiated by a call to the client ASPxClientDashboard.PerformDataCallback method.

(Inherited from ASPxDashboard)
CustomExport

Allows you to customize the exported document.

(Inherited from ASPxDashboard)
CustomFilterExpression

Allows you to include WHERE clauses into DashboardSqlDataSource queries.

(Inherited from ASPxDashboard)
CustomJSProperties

Enables you to supply any server data that can then be parsed on the client.

(Inherited from ASPxDashboard)
CustomPalette

Provides the capability to substitute the default palette containing colors used to paint dashboard item elements.

(Inherited from ASPxDashboard)
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.

(Inherited from ASPxDashboard)
CustomizeExportDocument

Allows you to customize the exported document.

(Inherited from ASPxDashboard)
DashboardAdding

Allows you to add a new dashboard to the dashboard storage at runtime.

(Inherited from ASPxDashboard)
DashboardLoading

Allows you to load a dashboard at runtime.

(Inherited from ASPxDashboard)
DashboardSaving

Allows you to save a dashboard at runtime.

(Inherited from ASPxDashboard)
DataLoading

Allows you to provide data for the DashboardObjectDataSource.

(Inherited from ASPxDashboard)
ExcelDataSourceBeforeFill

Provides the capability to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.

(Inherited from ASPxDashboard)
RequestDashboardIDs

Allows you to specify dashboards available in the dashboard storage.

(Inherited from ASPxDashboard)
SetInitialDashboardState

Allows you to specify the initial dashboard state when loading a dashboard.

(Inherited from ASPxDashboard)
ValidateDashboardCustomSqlQuery

Provides the capability to check the validity of the custom SQL query used to supply the dashboard with data.

(Inherited from ASPxDashboard)