CustomParametersEventArgs Class

Provides data for the CustomParameters event.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public class CustomParametersEventArgs :
    EventArgs

VB.NET

Public Class CustomParametersEventArgs
    Inherits EventArgs

Related API Members

CustomParametersEventArgs is the data class for the following events:

• Dashboard.CustomParameters
• DashboardControl.CustomParameters
• DashboardDesigner.CustomParameters
• DashboardExporter.CustomParameters
• DashboardViewer.CustomParameters
• IDashboardControl.CustomParameters

Remarks

The CustomParameters event is raised before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing. To learn more, see the following topics.

• Dashboard.CustomParameters
• DashboardDesigner.CustomParameters
• DashboardViewer.CustomParameters

Related GitHub Examples

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

Note

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.

C#

wpf-dashboard-how-to-manage-dashboard-parameters-in-code/CS/WPF_Dashboard_CustomParameters/Views/MyDashboardView.xaml.cs#L16

private void DashboardControl_CustomParameters(object sender, DevExpress.DashboardCommon.CustomParametersEventArgs e)
{

how-to-pass-a-hidden-dashboard-parameter-to-a-custom-sql-query-in-the-winforms-viewer-t338459/CS/Dashboard_CustomParameters_Win/Form1.cs#L11

private void dashboardViewer1_CustomParameters(object sender, CustomParametersEventArgs e) {
    var custIDParameter = e.Parameters.FirstOrDefault(p => p.Name == "custIDDashboardParameter");

winforms-dashboard-how-to-manage-dashboard-parameters-in-code-t635871/CS/CustomParametersExample/ViewerForm1.cs#L36

private void DashboardViewer_CustomParameters(object sender, CustomParametersEventArgs e)
{

VB.NET

wpf-dashboard-how-to-manage-dashboard-parameters-in-code/VB/WPF_Dashboard_CustomParameters/Views/MyDashboardView.xaml.vb#L15

Private Sub DashboardControl_CustomParameters(ByVal sender As Object, ByVal e As DevExpress.DashboardCommon.CustomParametersEventArgs)
    Dim customParameter = e.Parameters.FirstOrDefault(Function(p) p.Name = "parameterState")

how-to-pass-a-hidden-dashboard-parameter-to-a-custom-sql-query-in-the-winforms-viewer-t338459/VB/Dashboard_CustomParameters_Win/Form1.vb#L13

Private Sub dashboardViewer1_CustomParameters(ByVal sender As Object, ByVal e As CustomParametersEventArgs) Handles dashboardViewer1.CustomParameters
    Dim custIDParameter = e.Parameters.FirstOrDefault(Function(p) p.Name = "custIDDashboardParameter")

winforms-dashboard-how-to-manage-dashboard-parameters-in-code-t635871/VB/CustomParametersExample/ViewerForm1.vb#L34

Private Sub DashboardViewer_CustomParameters(ByVal sender As Object, ByVal e As CustomParametersEventArgs)
    Dim customParameter = e.Parameters.FirstOrDefault(Function(p) p.Name = "parameterState")

Inheritance

Object

EventArgs

CustomParametersEventArgs

CustomParametersWebEventArgs