XtraReport.RequestParameters Property

Specifies whether the report document creation should start only after the user submits all the report parameter values.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v23.2.dll

NuGet Package: DevExpress.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 create a document after the user submits report parameters; otherwise, false.

Remarks

If users should specify parameter values in your report, set the RequestParameters property to true.

When the RequestParameters property is true, the document is only created after the user submits values for all visible parameters in the Parameters panel.

If there are no visible parameters (the Parameter.Visible property is false for all parameters), the Parameters panel is not displayed and the RequestParameters property is not in effect.

Note

You can use the AutoShowParametersPanel property of the ReportPrintTool and the DocumentPreviewControl components to show/hide the Parameters panel.

For more information, review the following help topic: Use 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-web-object-data-source/CS/Reporting-How-To-Use-Object-Data-Source/MVC/CS/Reporting_ObjectDS_Mvc/Services/CustomWebDocumentViewerReportResolver.cs#L87

report.Parameters.Add(param);
report.RequestParameters = false;
return report;

reporting-winforms-add-report-parameters/CS/ReportParameterExample/Form1.cs#L33

// requesting the parameter value from end-users.
report.RequestParameters = false;

reporting-web-forms-object-data-source-constructor-parameters/CS/DXWebApplication1/Default.aspx.cs#L42

});
report.RequestParameters = false;
CreateReportControls(parameterName, report);

VB.NET

reporting-web-object-data-source/CS/Reporting-How-To-Use-Object-Data-Source/MVC/VB/Reporting_ObjectDS_Mvc/Services/CustomWebDocumentViewerReportResolver.vb#L76

report.Parameters.Add(param)
report.RequestParameters = False
Return report

reporting-winforms-add-report-parameters/VB/ReportParameterExample/Form1.vb#L31

' requesting the parameter value from end-users.
report.RequestParameters = False
' Show the parameter's value on a Report Header band.

reporting-web-forms-object-data-source-constructor-parameters/VB/DXWebApplication1/DXWebApplication1/Default.aspx.vb#L28

                          .Value = 5}) ' Specify the default value for the report parameter.
report.RequestParameters = False
CreateReportControls(parameterName, report)