How to: Access the Report Parameters Object in Report Scripts

• Jun 11, 2021

This topic describes how you can access data of the report parameters object (inherited from ReportParametersObjectBase and specified using IReportDataV2.ParametersObjectType) in report scripts.

Use the following code to access the Parameters Object from a script.

C#

object xafParameters = 
    ((DevExpress.XtraReports.UI.XtraReport)sender).Parameters["XafReportParametersObject"].Value

VB.NET

Dim xafParameters As Object = _
CType(sender, DevExpress.XtraReports.UI.XtraReport).Parameters("XafReportParametersObject").Value

For instance, the following script displays the name of the Position selected in the parameters dialog as a label text.

C#

private void ContactsBaseReport_BeforePrint(object sender, System.Drawing.Printing.PrintEventArgs e) {
    label1.Text ="";
    DevExpress.XtraReports.Parameters.Parameter param = 
        (DevExpress.XtraReports.Parameters.Parameter)((DevExpress.XtraReports.UI.XtraReport)sender).
            Parameters["XafReportParametersObject"];
    if(param != null) {
        MySolution.DemoParameters xafParameter = 
            (MySolution.DemoParameters)param.Value;
        label1.Text = xafParameter.ContactPosition.Name;
    }
}

VB.NET

Private Sub ContactsBaseReport_BeforePrint(ByVal sender As Object, ByVal e As System.Drawing.Printing.PrintEventArgs)
    label1.Text =""
    Dim param As DevExpress.XtraReports.Parameters.Parameter = CType(CType(sender, DevExpress.XtraReports.UI.XtraReport).Parameters("XafReportParametersObject"), DevExpress.XtraReports.Parameters.Parameter)
    If param IsNot Nothing Then
        Dim xafParameter As MySolution.DemoParameters = CType(param.Value, MySolution.DemoParameters)
        label1.Text = xafParameter.ContactPosition.Name
    End If
End Sub