Parameters

The Report Designer allows you to use parameters to filter and otherwise manipulate the data to display in a report. You can prompt users for parameter values so that they control the contents of the report.

The example below shows a report that uses 2 parameters, in the Parameters Pane on the left of the preview window, to allow the user to define which Attribute will be summed, and how the data will be grouped.  This report is available in the report Designer under Stardraw Reports | Summary Reports | Configurable Report.

 

Report - Parameters Dialog

The Report - Parameters dialog allows you to control how and whether a user interface is presented to your users for each parameter. Parameter values are collected in the order they appear in the Report Parameters collection. You can change the order using the arrows in the Report - Parameters dialog.

The Report - Parameters dialog contains a parameters page with a list of parameters and three tabs to set parameter properties. You need to set the following properties in the dialog to create a parameter:

  1. In the General tab, enter a report parameter name. Each report parameter in the collection must have a unique name, and the name must match the name you enter or call in the Parameters page of the DataSet dialog.
  2. Set the data type, the text used to prompt the user, whether to allow null, blank, multiple values or multiline text, and whether to hide the user interface. For parameters with Date or DateTime data types, you have the choice to select the display format.
  3. Go to the Available tab to populate a list of available values from which users can choose, or the Default tab to set the default value.

The tabs in the Report - Parameters Dialog are explained below.

Parameter Properties Dialog

Click on a tab name below for more details on the properties it contains.

Note: In the Available Values tab the Value is what is passed to the query parameter, and the Label is what is shown to the user. For example, if the Value is an ID, you might want to supply a more user-friendly Label showing the name hat corresponds to the ID.

To access the Report - Parameters Dialog

You can access the Report - Parameters dialog through any one of the following: