DashboardBackendOptions Class
Contains options that allow you to configure the Web Dashboard’s back-end.
Namespace: DevExpress.DashboardWeb
Assembly: DevExpress.Dashboard.v19.2.Web.WebForms.dll
Declaration
Remarks
You can use the Web Dashboard for more than a combined application. The Web Dashboard allows you to separate the client and server parts. This means you can:
- Integrate the Web Dashboard in any place that supports HTTP requests (e.g., see the GitHub Pages Demo).
- Publish the Web Dashboard as a part of applications based on Angular, Knockout, Vue and similar frameworks.
- Use the Web Dashboard side-by-side with DevExtreme client-side widgets to create highly responsive web apps.
The table below illustrates correlations between server and client. The column headers display platforms you can use as a server, the row headers show available client counterparts.
Client \ Server | ASP.NET HTTP Handlers | ASP.NET MVC | ASP.NET Core |
---|---|---|---|
ASP.NET Web Forms (UseDashboardConfigurator = false)[1] | |||
ASP.NET Web Forms (UseDashboardConfigurator = true) | |||
ASP.NET MVC | |||
ASP.NET Core | |||
HTML JS |
Use the following properties/methods for a corresponding platform to configure server settings for the client application:
Platform | Member |
---|---|
ASP.NET Web Forms | |
ASP.NET MVC | |
ASP.NET Core | |
HTML JS | DashboardControlOptions.endpoint / AjaxRemoteServiceOptions.headers |
The code samples below show how to configure the client: set the server’s url and pass a custom Authorization header. Note that the server’s url should consist of a base URL where the Web Dashboard’s server side is hosted and a route prefix - a value that is set in the MVC / .NET Core MapDashboardRoute properties.
For MVC or ASP.NET Core back-end, the url is a controller’s address:
DashboardControl.BackendOptions.Uri = "{baseURL}/api/dashboard";
DashboardControl.BackendOptions.RequestHttpHeaders.Add("Authorization", "AuthToken123");
For a WebForms control that uses the DashboardConfigurator‘s instance API, provide the Dashboard HTTP handler’s url instead of the controller’s address:
DashboardControl.BackendOptions.Uri = "{baseURL}/api/dashboard/DXDD.axd";
You need to set up cross-origin resource sharing (CORS) on your back-end to configure corresponding permissions to access selected resources from a server at a different origin.
Inheritance
-
It is a default ASPxDashboardControl mode. See Server-Side API Overview to learn more.
-
In this case, the Web Forms Dashboard sends requests only to its own instance.