Back to Devexpress

DevExpress.DashboardWeb Namespace

dashboard-devexpress-b8d0a69d.md

latest26.3 KB
Original Source

DevExpress.DashboardWeb Namespace

Contains classes that implement the Web Dashboard.

Assemblies : DevExpress.Dashboard.v25.2.Web.dll, DevExpress.Dashboard.v25.2.Web.WebForms.dll

NuGet Packages : DevExpress.Web.Dashboard.Common, DevExpress.Web.Dashboard

Classes

NameDescription
ASPxDashboardA Web Dashboard control, which allows you to create new dashboards from scratch and display them to end-users.
ASPxDashboardExporterPerforms server-side export of a dashboard/dashboard item displayed in the Web Forms Dashboard.
BeforeExportDocumentWebEventArgsProvides data for the BeforeExportDocument events.
CardExportOptionsObsolete. Contains settings that specify parameters affecting how the card dashboard item is exported.
ChartExportOptionsObsolete. Contains settings that specify parameters affecting how the Chart dashboard item is exported.
ConfigureDataConnectionWebEventArgsProvides data for the ConfigureDataConnection events.
ConfigureDataReloadingTimeoutWebEventArgsProvides data for the ASPxDashboard.ConfigureDataReloadingTimeout and DashboardConfigurator.ConfigureDataReloadingTimeout events.
ConfigureItemDataCalculationWebEventArgsProvides data for the ASPxDashboard.ConfigureItemDataCalculation and DashboardConfigurator.ConfigureItemDataCalculation events.
ConnectionErrorWebEventArgsProvides data for the ASPxDashboard.ConnectionError and DashboardConfigurator.ConnectionError events.
CustomAssemblyLoadingWebEventArgsProvides data for the CustomAssemblyLoading events.
CustomColorSchemeExtension staticContains settings of the custom color scheme.
CustomExportBaseWebEventArgsServes as the base for classes providing data for events used to customize exported documents.
CustomExportWebEventArgsProvides data for the CustomExport events.
CustomFilterExpressionWebEventArgsProvides data for the CustomFilterExpression events.
CustomizeExportDocumentWebEventArgsProvides data for the CustomizeExportDocument events.
CustomPaletteWebEventArgsProvides data for the CustomPalette events.
CustomParametersWebEventArgsProvides data for the CustomParameters events.
DashboardAddingWebEventArgsProvides data for the ASPxDashboard.DashboardAdding event.
DashboardBackendOptionsContains options that allow you to configure the Web Dashboard’s back-end.
DashboardBootstrapper staticContains the ASPxDashboard control’s static settings.
DashboardConfiguratorProvides a server side API for the ASP.NET Core Dashboard control, ASP.NET Web Forms Dashboard control, and ASP.NET MVC Dashboard extension.
DashboardControlClientSideEventsContains a list of the client-side event handlers available for the ASPxDashboard control and a corresponding MVC extension.
DashboardCustomSqlExecutingExceptionThe exceptions that occur when the data source has custom SQL queries that can lead to inadvertent or unauthorized modifications to your data/database structure.
DashboardExportOptionsObsolete. Contains settings that specify default parameters affecting how the dashboard (dashboard item) is exported.
DashboardFileStorageA file storage used to hold dashboards.
DashboardInfoContains information used to identify a dashboard within the dashboard storage.
DashboardInMemoryStorageAn in-memory storage used to hold dashboards.
DashboardItemDataLoadingErrorWebEventArgsProvides data for the DashboardItemDataLoadingError event.
DashboardItemExportOptionsContains settings that specify export parameters related to individual dashboard items.
DashboardJsonConverter staticProvides methods that allow you to convert a dashboard XML definition to JSON and vice versa.
DashboardLoadedWebEventArgsProvides data for the ASPxDashboardViewer.DashboardLoaded event.
DashboardLoadingEventArgsProvides data for the ASPxDashboard.DashboardLoading event.
DashboardLoadingWebEventArgsProvides data for the ASPxDashboard.DashboardLoading event.
DashboardRestrictedModeExceptionThe exception that occurs when the user’s trust level is unsuitable to perform actions a client can initiate to execute on a server side.
DashboardSavingWebEventArgsProvides data for the ASPxDashboard.DashboardSaving event.
DashboardStateExtensions staticProvides extension methods for the DashboardState class.
DashboardStorageBaseServes as the base class for classes that act as dashboard storage.
DashboardTypeStorageA storage of dashboards created at design time within Visual Studio.
DashboardUnsafeConnectionExceptionThe exception that occurs when the dashboard contains unsafe data connection.
DataLoadingWebEventArgsProvides data for the DataLoading events.
DataSourceCacheKeyCreatedEventArgsProvides data for DashboardConfigurator.DataSourceCacheKeyCreated and ASPxDashboard.DataSourceCacheKeyCreated events.
DataSourceInMemoryStorageAn in-memory storage of the dashboard data sources.
DataSourceUnsafeConnectionExceptionThe exception that occurs when the data source contains unsafe data connection.
DocumentContentExportOptionsObsolete. Contains options specific to exporting additional content.
ExcelDataSourceBeforeFillWebEventArgsProvides data for the ExcelDataSourceBeforeFill events.
ExcelFormatExportOptionsObsolete. Contains options which define how the dashboard item is exported to Excel format.
ExportFontInfoObsolete. Contains the font settings of the exported document.
GaugeExportOptionsObsolete. Contains settings that specify parameters affecting how the Gauge dashboard item is exported.
GridExportOptionsObsolete. Contains settings that specify parameters affecting how the Grid dashboard item is exported.
ImageFormatExportOptionsObsolete. Contains settings that specify parameters affecting how the dashboard or dashboard item is exported in Image format.
MapExportOptionsObsolete. Contains settings that specify parameters affecting how Map dashboard items are exported.
OptionsBaseServes as the base class for classes containing specific export options.
PaddingContains properties used to set paddings of the Web Dashboard elements.
PieExportOptionsObsolete. Contains settings that specify parameters affecting how the Pie dashboard item is exported.
PivotExportOptionsObsolete. Contains settings that specify parameters affecting how the Pivot dashboard item is exported.
RangeFilterExportOptionsObsolete. Contains settings that specify parameters affecting how the Range Filter dashboard item is exported.
RequestDashboardIDsWebEventArgsProvides data for the ASPxDashboard.RequestDashboardIDs event.
RuntimeConnectionStringProvider
SaveDashboardEventArgsProvides data for the DashboardInMemoryStorage.DashboardSave event.
SetInitialDashboardStateEventArgsProvides data for the ASPxDashboard.SetInitialDashboardState event.
TreemapExportOptionsObsolete. Contains settings that specify parameters affecting how the Treemap dashboard item is exported.
ValidateDashboardCustomSqlQueryWebEventArgsProvides data for the ValidateDashboardCustomSqlQuery events.
ValidateUnderlyingDataColumnsWebEventArgsProvides data for the DashboardConfigurator.ValidateUnderlyingDataColumns and ASPxDashboard.ValidateUnderlyingDataColumns events.
VerifyClientTrustLevelEventArgsProvides data for the DashboardConfigurator.VerifyClientTrustLevel event.
WebDashboardExporterImplements a base functionality to perform server-side export of a dashboard/dashboard item displayed in the Web Dashboard.

Interfaces

NameDescription
IDashboardStateServiceWhen implemented by a class, provides a service used to manage a dashboard state.
IDashboardStorageCustom storage of dashboards.
IDataSourceStorageWhen implemented by a class, represents a storage of the dashboard data sources.
IDataSourceWizardConnectionStringsStorageWhen implemented by a class, represents a storage of data connections used in the Dashboard Data Source Wizard.
IEditableDashboardStorageCustom editable storage of dashboards.

Delegates

NameDescription
BeforeExportDocumentWebEventHandlerReferences a method that handles the BeforeExportDocument events.
ConfigureDataConnectionWebEventHandlerReferences a method that handles the ConfigureDataConnection events.
ConfigureDataReloadingTimeoutWebEventHandlerReferences a method that handles the ConfigureDataReloadingTimeout events.
ConfigureItemDataCalculationWebEventHandlerReferences a method that handles the ASPxDashboard.ConfigureItemDataCalculation and DashboardConfigurator.ConfigureItemDataCalculation events.
ConnectionErrorWebEventHandlerReferences a DevExpress.DashboardWpf.ConnectionErrorWpfEventArgs method that will handle the ASPxDashboard.ConnectionError and DashboardConfigurator.ConnectionError events.
CustomAssemblyLoadingWebEventHandlerReferences a method that handles the CustomAssemblyLoading events.
CustomExportWebEventHandlerReferences a method that handles the CustomExport events.
CustomFilterExpressionWebEventHandlerReferences a method that handles the CustomFilterExpression events.
CustomizeExportDocumentWebEventHandlerReferences a method that handles the CustomizeExportDocument events.
CustomPaletteWebEventHandlerReferences a method that handles the CustomPalette events.
CustomParametersWebEventHandlerReferences a method that handles the CustomParameters events.
DashboardAddingWebEventHandlerReferences a method that handles the ASPxDashboard.DashboardAdding event.
DashboardItemDataLoadingErrorWebEventHandler
DashboardLoadedWebEventHandlerReferences a method that handles the ASPxDashboardViewer.DashboardLoaded event.
DashboardLoadingEventHandler
DashboardLoadingWebEventHandlerReferences a method that handles the ASPxDashboard.DashboardLoading event.
DashboardSaveEventHandlerReferences a method that handles the DashboardInMemoryStorage.DashboardSave event.
DashboardSavingWebEventHandlerReferences a method that handles the ASPxDashboard.DashboardSaving event.
DataLoadingWebEventHandlerReferences a method that handles the DataLoading events.
DataSourceCacheKeyCreatedEventHandlerReferences a method that handles DashboardConfigurator.DataSourceCacheKeyCreated and ASPxDashboard.DataSourceCacheKeyCreated events.
ExcelDataSourceBeforeFillWebEventHandlerReferences a method that handles the ExcelDataSourceBeforeFill events.
RequestDashboardIDsWebEventHandlerReferences a method that handles the ASPxDashboard.RequestDashboardIDs event.
SetInitialDashboardStateEventHandlerReferences a method that handles the ASPxDashboard.SetInitialDashboardState event.
ValidateDashboardCustomSqlQueryWebEventHandlerReferences a method that handles the ValidateCustomSqlQuery events.
ValidateUnderlyingDataColumnsWebEventHandlerReferences a method that handles the ValidateUnderlyingDataColumns events.
VerifyClientTrustLevelEventHandlerReferences a method that handles the DashboardConfigurator.VerifyClientTrustLevel event.

Enums

NameDescription
ChartExportSizeModeObsolete. Lists values used to specify how a Chart dashboard item should be resized when being exported.
ClientTrustLevelLists trust levels that specify which actions a client can initiate on the server.
DashboardExportExcelFormatObsolete. Lists values that specify Excel formats available for exporting individual dashboard items.
DashboardExportFilterStateObsolete. Lists values that specify the filter state’s location on the exported document.
DashboardExportImageFormatObsolete. Lists values that specify the image format used for exporting a dashboard/dashboard item.
DashboardExportPageLayoutObsolete. Lists values that specify the page orientation used to export a dashboard (dashboard item).
DashboardExportScaleModeObsolete. Lists values that specify a scale mode when exporting a dashboard (dashboard item).
MapExportSizeModeObsolete. Lists values used to specify how a Map dashboard item should be resized when being exported.
RangeFilterExportSizeModeObsolete. Lists values used to specify how a range filter dashboard item should be resized when being exported.
TreemapExportSizeModeObsolete. Lists constants used to specify how the Treemap dashboard item should be resized when being exported.