XtraReport.ParametersRequestSubmit Event

Occurs when all parameter values in the Parameters UI are entered, and the Submit button is pressed.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Reporting.Core

Declaration

C#

public event EventHandler<ParametersRequestEventArgs> ParametersRequestSubmit

VB.NET

Public Event ParametersRequestSubmit As EventHandler(Of ParametersRequestEventArgs)

Event Data

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

Property	Description
ParametersInformation	Provides access to information about the requested parameters.

Remarks

Note

The ParametersRequestSubmit event fires only for desktop applications (Windows Forms and WPF).

Use the ParametersRequestSubmit event to customize the Parameters UI (e.g. to perform some error checking when an end-user submits parameter values). The ParametersRequestEventArgs class introduces the ParametersRequestEventArgs.ParametersInformation property, which provides access to information about parameters. Each ParameterInfo class contains information about the ParameterInfo.Parameter itself, as well as about the ParameterInfo.Editor which is used to enter the parameter’s value.

When the ParametersRequestSubmit event is raised, each parameter returned by the ParameterInfo.Parameter property contains a value that was set before the Parameters UI is invoked. If you want to access the values entered by an end-user into the Parameters UI, use the values provided by the ParameterInfo.Editor property instead.

To learn more, see Using Report Parameters.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ParametersRequestSubmit event.

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#

Reporting_how-to-create-a-hierarchical-report-t456484/CS/TreeViewReport/TreeReport.cs#L22

    InitializeComponent();
    this.ParametersRequestSubmit += TreeReport_ParametersRequestSubmit;
}

VB.NET

Reporting_how-to-create-a-hierarchical-report-t456484/VB/TreeViewReport/TreeReport.vb#L24

    InitializeComponent()
    AddHandler Me.ParametersRequestSubmit, AddressOf TreeReport_ParametersRequestSubmit
End Sub

Implements

DevExpress.XtraReports.IReport.ParametersRequestSubmit