Skip to end of metadata
Go to start of metadata

This topic provides an in-depth explanation on how to create report parameters, pass parameter values, and use it inside a report document. To give a clear explanation on ReportParameter, this topic is divided into the several sections. To learn more about report parameters, see Report Parameters Overview.

On this page:

Creating Report Parameters

To create report parameters at design time, simply navigate to the Report Explorer tab and you will find an option to Add Parameter.

When you click it, a parameter editor will be shown.

There are several modes you can choose while creating a report parameter.

  • Standard Paramater
    The default mode which is used to create a simple parameter with less configuration.
  • Range Parameter
    This mode is used when you need to create a parameter which supports range value. Note that, it is only applicable for numeric data types, DateTime, and TimeSpan.

  • List Parameter
    This mode is used when you need to add predefined values for the parameters. Predefined values can be retrieved from a data source or static list.

  • Searchable Parameter
    This mode is recommended to be used when you need to retrieve predefined values from a large data source. UXPageableComboBox will be used here as it support data searching mechanism.
  • Linked Parameter
    This mode is used when you need to create a linked parameter, which use linked combo as the input control.

Passing Parameter Values

ClientUI Reporting allow parameter values to be passed before report is being rendered. You can pass it programmatically from your application. Note that, the passed paramater's name should matches the parameter's name defined within the report's data definitions. To prevent any unpredictable results, it is recommended to pass the parameter values when the ReportDefinition property of ReportViewer is changed, since at that time the report is still in initialization state.



Using Report Parameter 

After created, report parameter can be used in many ways during report rendering. You can display it on the report as a text, perform data filtering, conditional formatting, or other complex operations by using scripting. To learn about data filtering, see Filtering Data. To learn about conditional formatting, see Using Conditional Formatting. To learn about scripting, see Scripting Overview.