Report parameters

To set report parameters in the Bold Reports^® ASP.NET Core Report Viewer, pass the default values at run time with the parameters property. You can set the report parameters while creating the Report Viewer control in a script or in the Web API Controller.

This tutorial uses the sales-order-detail.rdl report. Download the sales-order-detail report.

Set a parameter with razor view

The Report Viewer parameter property does not support creating a parameter collection in a Razor view. Create and assign the parameter with the help of ViewBag as follows:

        public ActionResult Index()
        {
            List<BoldReports.Models.ReportViewer.ReportParameter> parameters = new List<BoldReports.Models.ReportViewer.ReportParameter>();
            parameters.Add(new BoldReports.Models.ReportViewer.ReportParameter()
            {
                Name = "SalesOrderNumber",
                Values = new List<string>(){ "SO50756" }
            });
            ViewBag.parameters = parameters;
            return View();
        }

<bold-report-viewer id="reportviewer1" report-service-url="../ReportApi" processing-mode="Remote" parameters="ViewBag.parameters" />

How do I set parameters in the Web API controller?

To set a parameter default value for the Report Viewer in the Web API controller, use the following code in the OnReportLoaded method.

[NonAction]
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;
}

Report parameter names are case sensitive.

How do I get the report parameters?

To get the report parameters used in a report, call the ReportHelper class methods in the Report Viewer Web API controller. The following helper methods get parameters 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;
        private IMemoryCache _cache;
        private IWebHostEnvironment _hostingEnvironment;

        public ReportViewerController(IMemoryCache memoryCache, IWebHostEnvironment hostingEnvironment)
        {
            _cache = memoryCache;
            _hostingEnvironment = hostingEnvironment;
        }

        public object PostReportAction(Dictionary<string, object> jsonResult)
        {
            jsonArray = jsonResult;
            return ReportHelper.ProcessReport(jsonResult, this);
        }

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

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

                reportOption.ReportModel.Parameters = modifiedParameters;
            }
        }
    }

How do I set a date range for a date parameter?

To set a date range for date parameters in the Report Viewer, use the MaxDateTime and MinDateTime properties in the parameterSettings.

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 the date range using parameterSettings in the Report Viewer controller.

        public ActionResult Index()
        {
            ViewBag.parameterSettings = new BoldReports.Models.ReportViewer.ParameterSettings();
            ViewBag.parameterSettings.MaxDateTime = new DateTime(2003, 8, 22);
            ViewBag.parameterSettings.MinDateTime = new DateTime(2003, 4, 22);
            return View();
        }

Refer to the following code sample to set the date range in the Report Viewer initialization.

<bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" parameter-settings="ViewBag.parameterSettings"> </bold-report-viewer>

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

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

      <bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" report-path="product-line-sales.rdl" before-parameter-add="beforeParameterAdd"> </bold-report-viewer>
       <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>

How do I set the date and time display format for a date parameter?

To set the date and time format that the DateTimePicker control displays for date parameters in the Report Viewer, use the dateTimeFormat and timeDisplayFormat properties in the parameterSettings.

Format	Display in DateTimePicker
`Short Date and Time - d/M/yy h:mm tt`	`9/12/2014 2:04 PM`
`Medium Date - d MMM yy h:mm tt`	`12 Sep 14 2:04: PM`
`Full Date and short time - dddd, MMMM dd, yyyy HH:mm tt`	`Friday, September 12,2014 2:04 PM`
`Full Date and Long Time - dddd, MMMM dd, yyyy HH:mm:ss tt`	`Friday, September 12,2014 2:04:00 PM`
`UTC - yyyy-MM-dThh:mm:ssz`	`2014-09-12T2:04:00+5`

Refer to the following code sample to set the date and time display format using parameterSettings in the Report Viewer controller.

        public ActionResult Index()
        {
            ViewBag.parameterSettings = new BoldReports.Models.ReportViewer.ParameterSettings();
            ViewBag.parameterSettings.DateTimeFormat = "d/M/yyyy h:mm tt";
            ViewBag.parameterSettings.TimeDisplayFormat = "HH:mm";
            ViewBag.parameterSettings.TimeInterval = 60;
            return View();
        }

Refer to the following code sample to set the date and time display format in the Report Viewer initialization.

<bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" parameter-settings="ViewBag.parameterSettings"> </bold-report-viewer>

The previous code sets the date and time display format for all the date parameters used in the report.

To set a different date and time display format for each date parameter used in the report, register the beforeParameterAdd event and specify the format based on the parameter name, as in the following code sample.

      <bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" report-path="product-line-sales.rdl" before-parameter-add="beforeParameterAdd"> </bold-report-viewer>
       <script type="text/javascript">
       function beforeParameterAdd(args) {
           if (args.parameterModel.Name === "StartDate") {
               args.parameterSettings.dateTimeFormat = "d/M/yyyy h:mm tt";
               args.parameterSettings.timeDisplayFormat = "HH:mm";
               args.parameterSettings.timeInterval = 60;
            }
            if (args.parameterModel.Name === "EndDate") {
               args.parameterSettings.dateTimeFormat = "d/M/yyyy h:mm tt";
               args.parameterSettings.timeDisplayFormat = "HH:mm";
               args.parameterSettings.timeInterval = 60;}
        }
</script>

How do I change the parameter drop-down height and width?

To change the height and width of the parameter drop-down in the Report Viewer parameter panel, use the parameterSettings property.

<bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" parameter-settings="ViewBag.parameterSettings"> </bold-report-viewer>

    public ActionResult Index()
    {
        ViewBag.parameterSettings = new BoldReports.Models.ReportViewer.ParameterSettings();
        ViewBag.parameterSettings.PopupHeight = "200px";
        ViewBag.parameterSettings.PopupWidth = "100px";
        return View();
    }

How do I hide the parameter scroller?

To hide the scrollbar in the Report Viewer parameter panel, use the enableparameterblockscroller property.

<bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" enable-parameter-block-scroller="true"> </bold-report-viewer>

How do I hide the parameter pane on load?

To hide or show the parameter block in the Report Viewer, use the parameterSettings property.

<bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" parameter-settings="ViewBag.parameterSettings"> </bold-report-viewer>

    public ActionResult Index()
    {
        ViewBag.parameterSettings = new BoldReports.Models.ReportViewer.ParameterSettings();
        ViewBag.parameterSettings.HideParameterBlock = true;
        return View();
    }

How do I change the parameter item width and label width?

To change the parameter item width and label width in the Report Viewer, use the parameterSettings property.

<bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" parameter-settings="ViewBag.parameterSettings"> </bold-report-viewer>

    public ActionResult Index()
    {
        ViewBag.parameterSettings = new BoldReports.Models.ReportViewer.ParameterSettings();
        ViewBag.parameterSettings.ItemWidth = "250px";
        ViewBag.parameterSettings.LabelWidth = "auto";
        return View();
    }

How do I access hidden or internal parameter information?

To expose the hidden or internal report parameter information used in a report to the user, set the accessInternalValue property in the Report Viewer parameterSettings.

<bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" parameter-settings="ViewBag.parameterSettings"> </bold-report-viewer>

    public ActionResult Index()
    {
        ViewBag.parameterSettings = new BoldReports.Models.ReportViewer.ParameterSettings();
        ViewBag.parameterSettings.AccessInternalValue = true;
        return View();
    }

How do I set report parameter visibility in the Web API controller?

To show or hide a parameter at the top of the Report Viewer panel, set the Hidden property of ReportParameter in the Web API controller. The following code example shows hiding a report parameter in the Web API controller’s OnReportLoaded method.

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

        if (reportParameters != null)
        {
            foreach (var rptParameter in reportParameters)
            {
                modifiedParameters.Add(new BoldReports.Web.ReportParameter()
                {
                    Name = rptParameter.Name,
                    Hidden = true
                });
            }

            reportOption.ReportModel.Parameters = modifiedParameters;
        }
    }