DashboardConfigurator Members
Provides a server side API for the ASP.NET Core Dashboard control, ASP.NET Web Forms Dashboard control, and ASP.NET MVC Dashboard extension.Constructors
| Name | Description |
|---|---|
| DashboardConfigurator() | Initializes a new instance of the DashboardConfigurator class. |
Properties
| Name | Description |
|---|---|
| AllowExecutingCustomSql | Gets or sets whether to execute SQL queries on the server side. |
| 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. |
| DashboardStorage | Gets a storage of dashboards for the Web Dashboard. |
| DataSourceCacheEnabled | Specifies whether the Web Dashboard Control caches its data sources. |
| DataSourceStorage | Gets the data source storage used by the Web Dashboard. |
| Default static | Gets the default DashboardConfigurator class instance. |
| PassCredentials static | Gets or sets whether confidential information (such as user credentials) will be passed to the client side (web browser). |
Methods
| Name | Description |
|---|---|
| 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. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| 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. |
| SetDashboardStateService(IDashboardStateService) | Specifies a service that allows you to manage a dashboard state. |
| SetDashboardStorage(DashboardFileStorage) | Specifies a file storage of dashboards for the Web Dashboard. |
| SetDashboardStorage(DashboardInMemoryStorage) | Specifies an in-memory storage of dashboards for the Web Dashboard. |
| SetDashboardStorage(IDashboardStorage) | Specifies a storage of dashboards for the Web Dashboard. |
| SetDashboardStorage(IEditableDashboardStorage) | Specifies an editable storage of dashboards for the Web Dashboard. |
| SetDataSourceProtectionService(IDataSourceProtectionService) | |
| SetDataSourceStorage(DataSourceInMemoryStorage) | Specifies a data source storage for the Web Dashboard. |
| SetDataSourceStorage(IDataSourceStorage) | Specifies a data source storage for the Web Dashboard. |
| SetDBCommandInterceptor(IDBCommandInterceptor) |
Registers IDBCommandInterceptor in DashboardConfigurator.
|
| SetDBConnectionInterceptor(IDBConnectionInterceptor) |
Registers IDBConnectionInterceptor in DashboardConfigurator.
|
| SetDBSchemaProvider(IDBSchemaProvider) | Specifies a custom data store schema. |
| SetDBSchemaProvider(IDBSchemaProviderEx) | Specifies a database schema provider for the Web Dashboard. |
| SetEFContextProvider(IEFContextProvider) |
Configures the service that creates an EF Core context object within DashboardConfigurator.
|
| SetObjectDataSourceCustomFillService(IObjectDataSourceCustomFillService) | Specifies a custom fill service for the DashboardObjectDataSource that provides data for the Web Dashboard. |
| 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. |
| ConfigureDataConnection | Allows you to customize connection settings before the Web Dashboard 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 users 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. |
| 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). |
| 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 customize dashboard parameters that are used for data processing. |
| 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. |
| ExcelDataSourceBeforeFill | Provides the capability to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files. |
| ValidateCustomSqlQuery | 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. |
| VerifyClientTrustLevel | Allows you to verify the trust level used to specify which actions a client can initiate on the server. |
See Also