Member Table: Dashboard Parameters

• Sep 05, 2018
• 2 minutes to read

Use the Dashboard.Parameters property to create and configure dashboard parameters.

Members

The following members allow you to manage parameters on the client side.

• WinForms DashboardDesigner

  API	Description
  DashboardDesigner.ShowDashboardParametersForm	Invokes the Dashboard Parameters dialog in the DashboardDesigner.
  DashboardDesigner.Parameters	Provides access to dashboard parameter settings and metadata.
  DashboardDesigner.CustomParameters	Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing.

• WinForms DashboardViewer

  API	Description
  DashboardViewer.ShowDashboardParametersForm	Invokes the Dashboard Parameters dialog in the DashboardViewer.
  DashboardViewer.Parameters	Provides access to dashboard parameter settings and metadata.
  DashboardViewer.CustomParameters	Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing.

• ASPxDashboard/MVCxDashboard

  Server-side API	Description
  ASPxDashboard.CustomParameters DashboardConfigurator.CustomParameters	Occurs before data is loaded from the data store and allows you to change parameter values before they are passed to a data query.
  Client-side API	Description
  ASPxClientDashboard.ShowParametersDialog	Invokes the Dashboard Parameters dialog.
  ASPxClientDashboard.HideParametersDialog	Closes the Dashboard Parameters dialog.
  ASPxClientDashboard.GetParameters	Returns dashboard parameter settings and metadata.
  ASPxClientDashboard.DynamicLookUpValuesLoaded	Occurs after parameter values provided using a Dynamic List are loaded.

• WPF DashboardControl

  API	Description
  DashboardControl.ParametersTemplate	Allows you to specify a custom Dashboard Parameters dialog template.
  DashboardControl.ShowParametersButton	Gets or sets whether to display the Parameters button in the dashboard title.
  DashboardControl.CustomParameters	Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing.

Related Classes

Name	Description
DashboardParameter	A dashboard parameter.
DashboardParameterDescriptor	Contains the parameter settings and metadata.
ASPxClientDashboardParameter	A client-side dashboard parameter.