The requested page is not available for the requested platform. You are viewing the content for Default platform.

DevExpress.DashboardWeb Namespace

Contains classes that implement the Web Dashboard.

Classes

Name Description
ASPxDashboard

A Web Dashboard control, which allows you to create new dashboards from scratch and display them to end-users.

ASPxDashboardDesignModeImages
ASPxDashboardExporter

Performs server-side export of a dashboard/dashboard item displayed in the Web Forms Dashboard.

BeforeExportDocumentWebEventArgs

Provides data for the BeforeExportDocument events.

CardExportOptions

Obsolete. Contains settings that specify parameters affecting how the card dashboard item is exported.

ChartExportOptions

Obsolete. Contains settings that specify parameters affecting how the Chart dashboard item is exported.

ConfigureDataConnectionWebEventArgs

Provides data for the ConfigureDataConnection events.

ConfigureDataReloadingTimeoutWebEventArgs

Provides data for the ASPxDashboard.ConfigureDataReloadingTimeout and DashboardConfigurator.ConfigureDataReloadingTimeout events.

ConfigureItemDataCalculationWebEventArgs

Provides data for the ASPxDashboard.ConfigureItemDataCalculation and DashboardConfigurator.ConfigureItemDataCalculation events.

ConnectionErrorWebEventArgs

Provides data for the ASPxDashboard.ConnectionError and DashboardConfigurator.ConnectionError events.

CustomAssemblyLoadingWebEventArgs

Provides data for the CustomAssemblyLoading events.

CustomColorSchemeExtension

Contains settings of the custom color scheme.

CustomExportBaseWebEventArgs

Serves as the base for classes providing data for events used to customize exported documents.

CustomExportWebEventArgs

Provides data for the CustomExport events.

CustomFilterExpressionWebEventArgs

Provides data for the CustomFilterExpression events.

CustomPaletteWebEventArgs

Provides data for the CustomPalette events.

CustomParametersWebEventArgs

Provides data for the CustomParameters events.

CustomizeExportDocumentWebEventArgs

Provides data for the CustomizeExportDocument events.

DashboardAddingWebEventArgs

Provides data for the ASPxDashboard.DashboardAdding event.

DashboardBackendOptions

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

DashboardBootstrapper

Contains the ASPxDashboard control's static settings.

DashboardConfigurator

Provides a server side API for the ASPxDashboard control and ASP.NET MVC Dashboard extension.

DashboardControlClientSideEvents

Contains a list of the client-side event handlers available for the ASPxDashboard control and a corresponding MVC extension.

DashboardCustomSqlExecutingException

The exceptions that occur when the data source has custom SQL queries that can lead to inadvertent or unauthorized modifications to your data/database structure.

DashboardExportOptions

Obsolete. Contains settings that specify default parameters affecting how the dashboard (dashboard item) is exported.

DashboardFileStorage

A file storage used to hold dashboards.

DashboardInMemoryStorage

An in-memory storage used to hold dashboards.

DashboardInfo

Contains information used to identify a dashboard within the dashboard storage.

DashboardItemExportOptions

Contains settings that specify export parameters related to individual dashboard items.

DashboardJsonConverter

Provides methods that allow you to convert a dashboard XML definition to JSON and vice versa.

DashboardLoadedWebEventArgs

Provides data for the ASPxDashboardViewer.DashboardLoaded event.

DashboardLoadingEventArgs

Provides data for the ASPxDashboard.DashboardLoading event.

DashboardLoadingWebEventArgs

Provides data for the ASPxDashboard.DashboardLoading event.

DashboardRestrictedModeException

The exception that occurs when the user's trust level is unsuitable to perform actions a client can initiate to execute on a server side.

DashboardSavingWebEventArgs

Provides data for the ASPxDashboard.DashboardSaving event.

DashboardStateExtensions

Provides extension methods for the DashboardState class.

DashboardStorageBase

Serves as the base class for classes that act as dashboard storage.

DashboardTypeStorage

A storage of dashboards created at design time within Visual Studio.

DashboardUnsafeConnectionException

The exception that occurs when the dashboard contains unsafe data connection.

DataLoadingWebEventArgs

Provides data for the DataLoading events.

DataRequestOptions

Contains options that allow you to configure data request parameters.

DataSourceInMemoryStorage

An in-memory storage of the dashboard data sources.

DataSourceUnsafeConnectionException

The exception that occurs when the data source contains unsafe data connection.

DocumentContentExportOptions

Obsolete. Contains options specific to exporting additional content.

ExcelDataSourceBeforeFillWebEventArgs

Provides data for the ExcelDataSourceBeforeFill events.

ExcelFormatExportOptions

Obsolete. Contains options which define how the dashboard item is exported to Excel format.

ExportFontInfo

Obsolete. Contains the font settings of the exported document.

GaugeExportOptions

Obsolete. Contains settings that specify parameters affecting how the Gauge dashboard item is exported.

GridExportOptions

Obsolete. Contains settings that specify parameters affecting how the Grid dashboard item is exported.

ImageFormatExportOptions

Obsolete. Contains settings that specify parameters affecting how the dashboard or dashboard item is exported in Image format.

MapExportOptions

Obsolete. Contains settings that specify parameters affecting how Map dashboard items are exported.

OptionsBase

Serves as the base class for classes containing specific export options.

Padding

Contains properties used to set paddings of the Web Dashboard elements.

PieExportOptions

Obsolete. Contains settings that specify parameters affecting how the Pie dashboard item is exported.

PivotExportOptions

Obsolete. Contains settings that specify parameters affecting how the Pivot dashboard item is exported.

RangeFilterExportOptions

Obsolete. Contains settings that specify parameters affecting how the Range Filter dashboard item is exported.

RequestDashboardIDsWebEventArgs

Provides data for the ASPxDashboard.RequestDashboardIDs event.

RuntimeConnectionStringProvider
SaveDashboardEventArgs

Provides data for the DashboardInMemoryStorage.DashboardSave event.

SetInitialDashboardStateEventArgs

Provides data for the ASPxDashboard.SetInitialDashboardState event.

TreemapExportOptions

Obsolete. Contains settings that specify parameters affecting how the Treemap dashboard item is exported.

ValidateDashboardCustomSqlQueryWebEventArgs

Provides data for the ValidateDashboardCustomSqlQuery events.

ValidateUnderlyingDataColumnsWebEventArgs

Provides data for the DashboardConfigurator.ValidateUnderlyingDataColumns and ASPxDashboard.ValidateUnderlyingDataColumns events.

VerifyClientTrustLevelEventArgs

Provides data for the DashboardConfigurator.VerifyClientTrustLevel event.

WebDashboardExporter

Implements a base functionality to perform server-side export of a dashboard/dashboard item displayed in the Web Dashboard.

Interfaces

Name Description
IDashboardStateService

When implemented by a class, provides a service used to manage a dashboard state.

IDashboardStorage

When implemented by a class, represents a storage of dashboards.

IDataSourceStorage

When implemented by a class, represents a storage of the dashboard data sources.

IDataSourceWizardConnectionStringsStorage

When implemented by a class, represents a storage of data connections used in the Dashboard Data Source Wizard.

IEditableDashboardStorage

When implemented by a class, represents an editable storage of dashboards.

Delegates

Name Description
BeforeExportDocumentWebEventHandler

References a method that handles the BeforeExportDocument events.

ConfigureDataConnectionWebEventHandler

References a method that handles the ConfigureDataConnection events.

ConfigureDataReloadingTimeoutWebEventHandler

References a method that handles the ConfigureDataReloadingTimeout events.

ConfigureItemDataCalculationWebEventHandler

References a method that handles the ASPxDashboard.ConfigureItemDataCalculation and DashboardConfigurator.ConfigureItemDataCalculation events.

ConnectionErrorWebEventHandler

References a DevExpress.DashboardWpf.ConnectionErrorWpfEventArgs method that will handle the ASPxDashboard.ConnectionError and DashboardConfigurator.ConnectionError events.

CustomAssemblyLoadingWebEventHandler

References a method that handles the CustomAssemblyLoading events.

CustomExportWebEventHandler

References a method that handles the CustomExport events.

CustomFilterExpressionWebEventHandler

References a method that handles the CustomFilterExpression events.

CustomPaletteWebEventHandler

References a method that handles the CustomPalette events.

CustomParametersWebEventHandler

References a method that handles the CustomParameters events.

CustomizeExportDocumentWebEventHandler

References a method that handles the CustomizeExportDocument events.

DashboardAddingWebEventHandler

References a method that handles the ASPxDashboard.DashboardAdding event.

DashboardLoadedWebEventHandler

References a method that handles the ASPxDashboardViewer.DashboardLoaded event.

DashboardLoadingEventHandler

 

DashboardLoadingWebEventHandler

References a method that handles the ASPxDashboard.DashboardLoading event.

DashboardSaveEventHandler

References a method that handles the DashboardInMemoryStorage.DashboardSave event.

DashboardSavingWebEventHandler

References a method that handles the ASPxDashboard.DashboardSaving event.

DataLoadingWebEventHandler

References a method that handles the DataLoading events.

ExcelDataSourceBeforeFillWebEventHandler

References a method that handles the ExcelDataSourceBeforeFill events.

RequestDashboardIDsWebEventHandler

References a method that handles the ASPxDashboard.RequestDashboardIDs event.

SetInitialDashboardStateEventHandler

References a method that handles the ASPxDashboard.SetInitialDashboardState event.

ValidateDashboardCustomSqlQueryWebEventHandler

References a method that handles the ValidateCustomSqlQuery events.

ValidateUnderlyingDataColumnsWebEventHandler

References a method that handles the ValidateUnderlyingDataColumns events.

VerifyClientTrustLevelEventHandler

References a method that handles the DashboardConfigurator.VerifyClientTrustLevel event.

Enums

Name Description
ChartExportSizeMode

Obsolete. Lists values used to specify how a Chart dashboard item should be resized when being exported.

ClientTrustLevel

Lists trust levels that specify which actions a client can initiate to execute them on a server side.

DashboardExportExcelFormat

Obsolete. Lists values that specify Excel formats available for exporting individual dashboard items.

DashboardExportFilterState

Obsolete. Lists values that specify the filter state's location on the exported document.

DashboardExportImageFormat

Obsolete. Lists values that specify the image format used for exporting a dashboard/dashboard item.

DashboardExportPageLayout

Obsolete. Lists values that specify the page orientation used to export a dashboard (dashboard item).

DashboardExportScaleMode

Obsolete. Lists values that specify a scale mode when exporting a dashboard (dashboard item).

ItemDataRequestMode

Lists values used to specify an item's data request mode.

LimitVisibleDataMode

Lists values that specify data limitation modes.

MapExportSizeMode

Obsolete. Lists values used to specify how a Map dashboard item should be resized when being exported.

MobileLayoutMode

Lists values that specify a mobile layout mode for the Web Dashboard.

RangeFilterExportSizeMode

Obsolete. Lists values used to specify how a range filter dashboard item should be resized when being exported.

TreemapExportSizeMode

Obsolete. Lists constants used to specify how the Treemap dashboard item should be resized when being exported.

WorkingMode

Lists values used to specify a working mode of the Web Dashboard.