How to: Specify Dashboard Parameter Values on the Client Side in the Web Viewer
- 3 minutes to read
Important
This documentation applies to v16.2. Starting with v17.1, the ASPxDashboardViewer control is in maintenance mode. In v19.1, the new Web Dashboard Control replaces the old Web Dashboard Viewer. This means that the Web Dashboard Viewer will not be included in our installation packages. See our blog post for more information.
Refer to the following KB articles to learn how to migrate to ASPxDashboard / ASP.NET MVC Dashboard:
ASPxDashboardViewer -> ASPxDashboard
How to migrate from ASPxDashboardViewer to ASPxDashboard working in the ViewerOnly mode
MVCxDashboardViewer -> MVCxDashboard
How to migrate from DashboardViewerExtension to DashboardExtension working in the ViewerOnly mode
This example demonstrates how to change dashboard parameter values in the Web Viewer on the client side using the ASPxClientDashboardViewer.GetParameters method.
In this example, current parameter values are specified between the ASPxClientDashboardViewer.BeginUpdateParameters and ASPxClientDashboardViewer.EndUpdateParameters method calls using the ASPxClientDashboardParameter.SetValue method.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/how-to-specify-dashboard-parameter-values-on-the-client-side-in-the-web-viewer-t205300.
- ParameterValues.js (C#)
- WebForm1.aspx.cs
- WebForm1.aspx (C#)
- WebForm1.aspx.vb
- ParameterValues.js (VB.NET)
- WebForm1.aspx (VB.NET)
function specifyParameterValues() {
var specifyValues = function () {
var parameters = webViewer.GetParameters();
var parameter1 = parameters.GetParameterByName("category1");
var parameter2 = parameters.GetParameterByName("startDate1");
webViewer.BeginUpdateParameters();
parameter1.SetValue(parameter1.GetValues()[1].GetValue());
parameter2.SetValue(new Date(1995, 3, 1));
webViewer.EndUpdateParameters();
};
$("#buttonContainer").dxButton({
clickAction: specifyValues,
text: "Specify parameter values"
});
};