Search results

Report parameters

Provides property options to pass or set report parameters default values at run time using the parameters property. You can set the report parameters while creating the Report Viewer control in a script or in the Web API Controller.

In this tutorial, the sales-order-detail.rdl report is used, and it can be downloaded from here.

Set parameter at client

  1. Set the ReportPath and ReportServiceUrl to the report viewer initialization.

    <div style="height: 650px;width: 950px;min-height:404px;">
        <Bold:ReportViewer runat="server" ID="viewer"
            ReportServiceUrl="/api/ReportViewer"
            ReportPath="~/Resources/sales-order-detail.rdl">
        </Bold:ReportViewer>
    </div>
  2. The following code is used to set the report parameter client side in your application’s Page_Load() function.

    protected void Page_Load(object sender, EventArgs e)
    {
        this.viewer.Parameters.Add(new BoldReports.Models.ReportViewer.ReportParameter()
        {
            Name = "SalesOrderNumber",
            Values = new List<string>() { "SO50756" }
        });
    }

Set parameters in Web API Controller

To set parameter default value in Web API Controller, use the following code in the OnReportLoaded method.

public void OnReportLoaded(ReportViewerOptions reportOption)
{
    List<BoldReports.Web.ReportParameter> userParameters = new List<BoldReports.Web.ReportParameter>();
    userParameters.Add(new BoldReports.Web.ReportParameter()
    {
        Name = "SalesOrderNumber",
        Values = new List<string>() { "SO50756" }
    });
    reportOption.ReportModel.Parameters = userParameters;
}

Get report parameter

The ReportHelper class provides methods to get the report parameters used in the report. The following helper methods used to get parameter with or without values.

Methods Description
GetParameters Returns the parameters used in the current report without the processed values.
GetParametersWithValues Returns the report parameters with processed data values that are used in the current report.

You can use the following code sample to get parameter names and set parameter default values.

public class ReportViewerController : ApiController, IReportController
{
    Dictionary<string, object> jsonArray = null;
    public object PostReportAction(Dictionary<string, object> jsonResult)
    {
        jsonArray = jsonResult;
        return ReportHelper.ProcessReport(jsonResult, this);
    }

    ....
    public void OnReportLoaded(ReportViewerOptions reportOption)
    {
        var reportParameters = ReportHelper.GetParameters(jsonArray, this);
        List<BoldReports.Web.ReportParameter> setParameters = new List<BoldReports.Web.ReportParameter>();

        if (reportParameters != null)
        {
            foreach (var rptParameter in reportParameters)
            {
                setParameters.Add(new BoldReports.Web.ReportParameter()
                {
                    Name = rptParameter.Name,
                    Values = new List<string>() { "SO50756" }
                });
            }

            reportOption.ReportModel.Parameters = setParameters;
        }
    }
}

Set date range for date parameter

The properties MaxDateTime and MinDateTime in the parameterSettings are used to set date range for date parameters in a report.

Property Description
MaxDateTime Specify minimum range value of a date parameter
MinDateTime Specify maximum range value of a date parameter

Refer to the following code sample to set data range to the report viewer initialization.

   <div style="height: 650px;width: 950px;min-height:404px;">
       <Bold:ReportViewer runat="server" ID="viewer"
           ReportServiceUrl="/api/ReportViewer"
           ReportPath="~/Resources/product-line-sales.rdl">
       </Bold:ReportViewer>
   </div>

Refer to the following code sample to set data range using parameterSettings in Report Viewer controller.

    protected void Page_Load(object sender, EventArgs e)
    {
        this.viewer.ParameterSettings = new BoldReports.Models.ReportViewer.ParameterSettings();
        this.viewer.ParameterSettings.MaxDateTime = new DateTime(2003, 6, 22);
        this.viewer.ParameterSettings.MinDateTime = new DateTime(2003, 5, 20);
    }

The above code sets date range for all the date parameters used in the report.

To set different date range for each date parameter used in the report, register the event beforeParameterAdd and specify range based on parameter name as in below code sample.

    <div style="height: 650px;width: 950px;min-height:404px;">
        <Bold:ReportViewer runat="server" ID="viewer"
            ReportServiceUrl="/api/ReportViewer"
            ReportPath="~/Resources/product-line-sales.rdl"
            OnClientBeforeParameterAdd="beforeParameterAdd" >
        </Bold:ReportViewer>
    </div>
    <script type="text/javascript">
        function beforeParameterAdd(args) {
        if (args.parameterModel.Name === "StartDate") {
            args.parameterSettings.minDateTime = new Date("4/5/2003 5:00:00 AM");
            args.parameterSettings.maxDateTime = new Date("4/15/2003 5:00:00 AM");
        }
        if (args.parameterModel.Name === "EndDate") {
            args.parameterSettings.minDateTime = new Date("5/10/2003 5:00:00 AM");
            args.parameterSettings.maxDateTime = new Date("5/20/2003 5:00:00 AM");
        }
    }
    </script>