XtraReport.RequestParameters Property

Specifies whether the report document creation should start after all the report parameters are submitted.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.1.dll

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

Declaration

C#

[DefaultValue(true)]
[PropertyGridTab(ReportStringId.UD_PropertyGrid_TabBehavior)]
[SRCategory(ReportStringId.CatParameters)]
public bool RequestParameters { get; set; }

VB.NET

<SRCategory(ReportStringId.CatParameters)>
<PropertyGridTab(ReportStringId.UD_PropertyGrid_TabBehavior)>
<DefaultValue(True)>
Public Property RequestParameters As Boolean

Property Value

Type	Default	Description
Boolean	true	true, to start to report document creation after submitting its parameters; otherwise, false.

Remarks

To pass a parameter’s value to a report by requesting this value from an end-user, enable the RequestParameters property.

When the RequestParameters property is set to true, the XtraReport.CreateDocument method is not called unless all parameter values are submitted via the Parameters user interface.

And when there are no visible parameters available, this user interface is not shown until the ReportPrintTool.AutoShowParametersPanel property is enabled.

To learn more, see Using Report Parameters.

Related GitHub Examples

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

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-assign-a-list-of-dynamic-values-to-a-report-parameter-e4081/CS/DynamicParameterValues/XtraReport1.cs#L46

    parameter1.Value = 1;
    this.RequestParameters = false;
}

Reporting_how-to-assign-a-list-of-static-values-to-a-report-parameter-e4082/CS/StaticParameterValues/XtraReport1.cs#L46

    parameter1.Value = 1;
    this.RequestParameters = false;
}

Reporting_how-to-use-a-stored-procedure-as-a-report-data-source-systemdatadataset-e1740/CS/Form1.cs#L14

report.RequestParameters = false;
new ReportPrintTool(report).ShowPreview();

VB.NET

Reporting_how-to-use-a-stored-procedure-as-a-report-data-source-systemdatadataset-e1740/VB/Form1.vb#L16

Dim report As XtraReport1 = New XtraReport1()
report.RequestParameters = False
Call New ReportPrintTool(report).ShowPreview()

Implements

DevExpress.XtraReports.IReport.RequestParameters