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.v23.2.dll

NuGet Package: DevExpress.Persistent.Base

Declaration

C#

public abstract class ReportParametersObjectBase

VB.NET

Public MustInherit Class ReportParametersObjectBase

Related API Members

The following members return ReportParametersObjectBase objects:

• CreateCustomParametersDetailViewEventArgs.ReportParametersObject
• CustomShowPreviewEventArgs.ParametersObject

Remarks

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).

C#

using DevExpress.Data.Filtering;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.DC;
using DevExpress.ExpressApp.ReportsV2;
using DevExpress.Xpo;
using DevExpress.Xpo.DB;
// ...
[DomainComponent]
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";
    }
}

VB.NET

Imports DevExpress.Data.Filtering
Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.DC
Imports DevExpress.ExpressApp.ReportsV2
Imports DevExpress.Xpo
Imports DevExpress.Xpo.DB
' ...
<DomainComponent> _
Public Class DemoParameters
    Inherits ReportParametersObjectBase

    Public Property SortByFirstName() As Boolean
    Public Property FilterByFirstName() As Boolean
    Public Property FirstName() As String
    Public Property FilterByPosition() As Boolean
    Public Property ContactPosition() As Position
    Public Sub New(ByVal provider As IObjectSpaceCreator)
        MyBase.New(provider)
    End Sub
    Protected Overrides Function CreateObjectSpace() As IObjectSpace
        Return objectSpaceCreator.CreateObjectSpace(GetType(Contact))
    End Function
    Public Overrides Function GetCriteria() As CriteriaOperator
        Dim criteriaName As CriteriaOperator = Nothing
        Dim criteriaPosition As CriteriaOperator = Nothing
        If FilterByFirstName Then
            criteriaName = CriteriaOperator.Parse("FirstName = ?", FirstName)
        End If
        If FilterByPosition Then
            criteriaPosition = CriteriaOperator.Parse("Position.Oid = ?", ContactPosition.Oid)
        End If
        Return CriteriaOperator.And(criteriaName, criteriaPosition)
    End Function
    Public Overrides Function GetSorting() As SortProperty()
        Dim sorting As New List(Of SortProperty)()
        If SortByFirstName Then
            sorting.Add(New SortProperty(NameOf(FirstName), SortingDirection.Ascending))
        End If
        Return sorting.ToArray()
    End Function
    Public Overrides Function ToString() As String
        Return "London"
    End Function
End Class

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.

Inheritance

Object

ReportParametersObjectBase