### Parameter

The properties of a parameter are:

Property Name | Description
--- | ---
General
Binding | Specifies the parameter which will be bound with the current one to sort the column controlled by the current parameter. Data type: String
Column | Specifies the bind column of the parameter. Data type: String
Columns | Specifies the display column of the parameter. Data type: String
Default Number | Specifies the parameter value that will be prompted by default at runtime. If it is set to 0, the first parameter value in the Value property will be prompted; if it is set to -1, the last parameter value in the Value property will be prompted. Data type: Integer
Description | Specifies the description of the parameter. Data type: String
Display Width | Specifies the display width of the parameter. Enter a numeric value to change the width. Data type: Float
Distinct | Specifies whether or not the text of the parameter is to be distinct. Data type: Boolean
GUI Field | Specifies the display format of the column when it is inserted into a report. It is a property provided for future use, at present do not enter any values for this property. Data type: String
Hide Parameter When Single Value Returned | When a parameter is bound with a column, you can choose to hide the parameter at runtime when only a single value is returned for the parameter, and the returned single value will be used as default value of the parameter. Data type: Boolean
Import SQL | Specifies the statement of the imported SQL file, which is created manually. Data type: String
Maximum Value | Specifies the maximum value (or length for a String type parameter) allowed for this parameter. Data type: String
Minimum Value | Specifies the minimum value (or length for a String type parameter) allowed for this parameter. Data type: String
Name | Specifies the name of the parameter. Data type: String
Object Name | Specifies the name for the OOJDBC class that is related to the parameter. Data type: String
Object Parameter Name | Specifies the parameter name for the OOJDBC class. Data type: String
Operation | Specifies whether or not to check the minimum and maximum values that you specified for the parameter at runtime. If -1, it will not check; if 1, it will check at runtime. Data type: Integer
Prompt Text | Specifies the prompt text of the parameter, which is used for prompting users to provide the value of the parameter. Data type: String
Record Level Security | When a parameter is bound with a column, you can specify a RLS policy defined on the bound column in the data source to the parameter, then at runtime, end users will be prompted to enter the security ID, which refers to the user name, and only the records the specified SID allowed to view will be displayed in the parameter value drop-down list. Data type: String
Required | Specifies whether or not the parameter will be treated as a required one. Data type: Boolean
String Format | Specifies the format for String type data. Data type: String
Type | Specifies the data type of the parameter. Choose an option from the drop-down list. Data type: Enumeration
Use Current Date-Time | Specifies whether or not to use the current system's date time as value of the parameter when the parameter type is Date, Time or DateTime. Data type: Boolean
Use Current Date-Time When Blank | Specifies whether or not to use the current system's date time as value of the parameter when the parameter type is Date, Time or DateTime, and the parameter value is blank. Data type: Boolean
Use Null for Blank String | Specifies whether or not to treat blank data values as nulls when its data type is String. Data type: Boolean
User Format | Specifies the user-defined format of the parameter value. Data type: String
Value | Lists the values of the parameter. This property is read only. Data type: String
Text Format
Autofit | Specifies whether to adjust the width of the parameter according to the contents. Data type: Boolean
Bold | Specifies whether to make the text bold. Data type: Boolean
Font Face | Specifies the font of the text. Choose an option from the drop-down list. Data type: Enumeration
Font Size | Specifies the font size of the text. Enter an integer value to change the size. Data type: Integer
Format | Specifies the display format of the parameter's value. The format varies with the parameter's data type and can be defined manually. Data type: String
Horizontal Alignment | Specifies the horizontal justification of the text in the parameter. Choose an option from the drop-down list. Data type: Enumeration
Italic | Specifies whether to make the text italic. Data type: Boolean
Strikethrough | Specifies whether to add a strikethrough line to the text. Data type: Boolean
Underline | Specifies whether to underline the text. Data type: Boolean
Vertical Alignment | Specifies the vertical justification of the text in the parameter. Choose an option from the drop-down list. Data type: Enumeration
Word Wrap | Specifies whether to wrap the text to the width. Data type: Boolean
Padding
Bottom Padding | Specifies the space between the text and the bottom border of the parameter. Enter a numeric value to change the padding. Data type: Float
Left Padding | Specifies the space between the text and the left border of the parameter. Enter a numeric value to change the padding. Data type: Float
Right Padding | Specifies the space between the text and the right border of the parameter. Enter a numeric value to change the padding. Data type: Float
Top Padding | Specifies the space between the text and the top border of the parameter. Enter a numeric value to change the padding. Data type: Float
Geometry
Height | Specifies the height of the parameter, which takes effect when the parameter is inserted into a report. Enter a numeric value to change the height. The default is 0 which means a proper height will be specified to the parameter by JReport automatically. Data type: Float
Width | Specifies the width of the parameter, which takes effect when the parameter is inserted into a report. Enter a numeric value to change the width. The default is 0 which means a proper width will be specified to the parameter by JReport automatically. Data type: Float
Color
Background | Specifies the background color of the parameter. Choose a color from the drop-down list, or enter a hexadecimal RGB value (0xCCAA00). Data type: String
Foreground | Specifies the foreground color of the parameter. Choose a color from the drop-down list, or enter a hexadecimal RGB value (0xCCAA00). Data type: String
Border
Border Color | Specifies the color of the border of the parameter. Choose a color from the drop-down list, or enter a hexadecimal RGB value (0xCCAA00). Data type: String
Border Thickness | Specifies the width of the border in inches or centimeters. Enter a numeric value to change the thickness. Data type: Float
Bottom Line | Specifies the line style of the bottom border of the parameter. Choose a style from the drop-down list. Data type: Enumeration
Left Line | Specifies the line style of the left border of the parameter. Choose a style from the drop-down list. Data type: Enumeration
Right Line | Specifies the line style of the right border of the parameter. Choose a style from the drop-down list. Data type: Enumeration
Shadow | Specifies whether or not to draw two shadowed borders, beneath and to the right of the parameter. Data type: Boolean
Shadow Color | Specifies the color of the border shadow. Choose a color from the drop-down list, or enter a hexadecimal RGB value (0xCCAA00). Data type: String
Pattern
Pattern Color | Specifies the color with which to draw a pattern to fill the parameter. Choose a color from the drop-down list, or enter a hexadecimal RGB value (0xCCAA00). Data type: String
Pattern Style | Specifies the style of the pattern. Choose an option from the drop-down list. none - No pattern will be applied to the parameter. 50% - The parameter will be filled in the specified color of 50%-transparency. horizontal - The pattern will be made of horizontal lines of the specified color. vertical - The pattern will be made of vertical lines of the specified color. grid - The pattern will be an overlapping of horizontal and vertical lines of the specified color. diagonal - The pattern will be made of slash lines of the specified color. Data type: Enumeration

#### User Format

For example, you define a parameter of Date type and the following formats can be recognized: M/d/yy; MMM d, yyyy; MMMM d, yyyy; EEEE, MMMM d, yyyy. But if you want to enter a value like 1996.July.10, you should specify the user defined format as yyyy.MMMM.d. But remember it is the entering format, not the display format. To customize the display format, go to its Format property in Report Inspector, enter your customized display format as yyyy.MMMM.d. Then when you enter 1996.July.10, it will be displayed as 1996.July.10.

Notes:

- The letters standing for year, month etc. are case sensitive and should follow the standard of JDK java.text.DateFormat, java.text.NumberFormat etc.
- For details about how to define a user format for different types of parameters, see the section User defined format for parameters.