ReportDataSourceHelperBase.SetupReport(XtraReport, ReportParametersObjectBase, CriteriaOperator, Boolean, SortProperty[], Boolean) Method

Initializes the specified report.

Namespace: DevExpress.ExpressApp.ReportsV2.Services

Assembly: DevExpress.ExpressApp.ReportsV2.v24.1.dll

NuGet Package: DevExpress.ExpressApp.ReportsV2

Declaration

C#

public void SetupReport(
    XtraReport report,
    ReportParametersObjectBase parametersObject,
    CriteriaOperator criteria,
    bool canApplyCriteria,
    SortProperty[] sortProperty,
    bool canApplySortProperty
)

VB.NET

Public Sub SetupReport(
    report As XtraReport,
    parametersObject As ReportParametersObjectBase,
    criteria As CriteriaOperator,
    canApplyCriteria As Boolean,
    sortProperty As SortProperty(),
    canApplySortProperty As Boolean
)

Parameters

Name	Type	Description
report	XtraReport	An XtraReport object that specifies the report.
parametersObject	ReportParametersObjectBase	A ReportParametersObjectBase object that specifies report parameters.
criteria	CriteriaOperator	A CriteriaOperator object used to filter data.
canApplyCriteria	Boolean	true, if the criteria can be applied; otherwise, false.
sortProperty	SortProperty[]	An array of SortProperty objects which specify data sorting.
canApplySortProperty	Boolean	true, if the sorting can be applied; otherwise, false.

Remarks

Internally, this method invokes the following ReportDataSourceHelper‘s methods, sequentially:

• ReportDataSourceHelperBase.SetupReportDataSource
• ReportDataSourceHelper.SetXafReportParametersObject
• ReportDataSourceHelper.RegisterObjectSpaceProviderService
• ReportDataSourceHelper.RegisterReportEnumLocalizer
• ReportDataSourceHelper.AttachCriteriaWithReportParametersManager

If there is no need to apply criteria, sorting, and pass report parameters, use another overload of the SetupReport method that takes the single report parameter. An example of using this overload is provided in the ReportDataSourceHelper.BeforeShowPreview topic.

Implements

SetupReport(XtraReport, ReportParametersObjectBase, CriteriaOperator, Boolean, SortProperty[], Boolean)