Skip to main content
.NET Framework 4.5.2+

ReportParametersObjectBase Class

The base class for classes that specify parameters shown in a popup Detail View before a report is executed.

Namespace: DevExpress.ExpressApp.ReportsV2

Assembly: DevExpress.Persistent.Base.v21.2.dll


public abstract class ReportParametersObjectBase


To create a custom report parameters object, inherit this class. Override the ReportParametersObjectBase.GetCriteria and ReportParametersObjectBase.GetSorting methods to specify criteria and sorting based on the user input (see Data Filtering in Reports V2 and Data Sorting in Reports V2).

using DevExpress.Data.Filtering;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.DC;
using DevExpress.ExpressApp.ReportsV2;
using DevExpress.Xpo;
using DevExpress.Xpo.DB;
// ...
public class DemoParameters : ReportParametersObjectBase {
    public bool SortByFirstName { get; set; }
    public bool FilterByFirstName { get; set; }
    public string FirstName { get; set; }
    public bool FilterByPosition { get; set; }
    public Position ContactPosition { get; set; }
    public DemoParameters(IObjectSpaceCreator provider) : base(provider) { }
    protected override IObjectSpace CreateObjectSpace() {
        return objectSpaceCreator.CreateObjectSpace(typeof(Contact));
    public override CriteriaOperator GetCriteria() {
        CriteriaOperator criteriaName = null;
        CriteriaOperator criteriaPosition = null;
        if (FilterByFirstName) {
            criteriaName = CriteriaOperator.Parse("FirstName = ?", FirstName);
        if (FilterByPosition) {
            criteriaPosition = CriteriaOperator.Parse("Position.Oid = ?", ContactPosition.Oid);
        return CriteriaOperator.And(criteriaName, criteriaPosition);
    public override SortProperty[] GetSorting() {
        List<SortProperty> sorting = new List<SortProperty>();
        if (SortByFirstName) {
            sorting.Add(new SortProperty(nameof(FirstName), SortingDirection.Ascending));
        return sorting.ToArray();
    public override string ToString() {
        return "London";

Do not forget to apply the DomainComponentAttribute to this class. Otherwise, the class will not be added to the Application Model and the report parameters Detail View will not be generated.

The CreateObjectSpace method should be overridden to create an object space capable of creating instances of a report’s data source type. The IObjectSpaceCreator.CreateObjectSpace method operates in the same manner as the XafApplication.CreateObjectSpace method with the objectType argument.

To assign the implemented parameters type to a report stored in the database, use the IReportDataV2.ParametersObjectType property. To assign it to a predefined report, pass the parametersObjectType parameter to the PredefinedReportsUpdater.AddPredefinedReport<T> method.


See Also