Skip to main content

DashboardConfigurator.CustomParameters Event

Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v22.1.Web.dll


public event CustomParametersWebEventHandler CustomParameters

Event Data

The CustomParameters event's data class is CustomParametersWebEventArgs. The following properties provide information specific to this event:

Property Description
DashboardId Gets the identifier of the required dashboard.
Parameters Gets or sets dashboard parameters. Inherited from CustomParametersEventArgs.



To learn how to use the DashboardConfigurator‘s API, see the Server-Side API Overview topic.

The CustomParameters event provides access to a collection of dashboard parameters (CustomParametersEventArgs.Parameters) and allows you to specify parameter values or add new parameters before they are passed to data queries.

Parameter values specified in the CustomParameters event handler are used only for data processing and are not displayed in the Dashboard Parameters dialog. You cannot access the dashboard parameters added in the CustomParameters event handler on the client side. However, these parameters can be seen in the exported document if the “Include Parameters” check box is enabled and the parameters’ DashboardParameter.Visible property is true.

To avoid the issue, use one of the following approaches:

1) Initialize a hidden Dashboard Parameter:

e.Parameters.Add(new DashboardParameter("Param1", typeof(string), "Parameter") { Visible = false });

2) Use Parameter that is always hidden:

e.Parameters.Add(new DevExpress.DataAccess.Parameter("Param1", typeof(string), "Parameter"));

The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomParameters event.


The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also