Parameter field

The properties of a parameter field in a web report are:

Property Name Description
General
Parameter Name Shows the name of the parameter. This property is read only.
Geometry
Height Specifies the height of the object, in inches or centimeters. Enter a numeric value to change the height.

Data type: Float
Width Specifies the width of the object, in inches or centimeters. Enter a numeric value to change the width.

Data type: Float
Color
Background Specifies the background color of the object. Choose a color from the drop-down list, enter a hexadecimal RGB value (for example, 0xff0000), or select Custom from the drop-down list to specify the color.

Data type: String

Foreground Specifies the foreground color of the object. Choose a color from the drop-down list, enter a hexadecimal RGB value (for example, 0xff0000), or select Custom from the drop-down list to specify the color.

Data type: String

CSS
ID Specifies the identifier of the object, which must be unique in the report. The ID property can be a style sheet selector. A String type value.
Class Specifies a CSS class to be applied to the object which is a valid class in the CSS file.

Data type: String
Style The property can be used in two ways.
  • Specifies a style to be applied to the object. Choose a style from the drop-down list which is available when a Style Group has been selected at the report tab level and when there are styles in the Style Group that can be applied to the object, or type in the style name.
  • Specifies a CSS selector to be applied to the object. Enter a valid class name from the CSS file.

Data type: String
Excel
Column Index Specifies the X coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the report level must be set to true for this property to take effect.

Data type: Integer
Row Index Specifies the Y coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the report level must be set to true for this property to take effect.

Data type: Integer
Padding
Bottom Padding Specifies the space in inches or centimeters between the text and the bottom border of the object. Enter a numeric value to change the padding.

Data type: Float

Left Padding Specifies the space in inches or centimeters between the text and the left border of the object. Enter a numeric value to change the padding.

Data type: Float

Right Padding Specifies the space in inches or centimeters between the text and the right border of the object. Enter a numeric value to change the padding.

Data type: Float

Top Padding Specifies the space in inches or centimeters between the text and the top border of the object. Enter a numeric value to change the padding.

Data type: Float

Border
Border Color Specifies the color of the border of the object. Choose a color from the drop-down list, enter a hexadecimal RGB value (for example, 0xCCAA00), or select Custom from the drop-down list to specify the color.

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 object. Choose a style from the drop-down list.

Data type: Enumeration
Left Line Specifies the line style of the left border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Right Line Specifies the line style of the right border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Shadow Specifies whether to draw two shadowed borders, beneath and to the right of the object.

Data type: Boolean

Shadow Color Specifies the color of the shadow. Choose a color from the drop-down list, enter a hexadecimal RGB value (for example, 0xff0000), or select Custom from the drop-down list to specify the color and fill effect.

Data type: String

Top Line Specifies the line style of the top border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Pattern
Pattern Color Specifies the color in which to draw a pattern to fill the object. Choose a color from the drop-down list, enter a hexadecimal RGB value (for example, 0xff0000), or select Custom from the drop-down list to specify the color and fill effect.

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 object.
  • 50% - The object will be filled in the Pattern Color of 50%-transparency.
  • horizontal - The pattern will be made of horizontal lines of the Pattern Color.
  • vertical - The pattern will be made of vertical lines of the Pattern Color.
  • grid - The pattern will be an overlapping of horizontal and vertical lines of the Pattern Color.
  • diagonal - The pattern will be made of diagonal lines of the Pattern Color.

Data type: Enumeration

Text Format
Auto Fit Specifies whether to adjust the width and height of the object 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 text in the report result. It varies with data type and can be manually defined.

Data type: String

Note: For the BigDecimal type, to avoid precision loss, you should enter a prefix JRD when setting the format property value.
Horizontal Alignment Specifies the horizontal justification of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration

Italic Specifies whether to make the text italic.

Data type: Boolean

Maximum Width Specifies the maximum width of the text displayed. Enter a numeric value to change the width.

This property often works with the Auto Fit property. If Auto Fit = true and Maximum Width is not equal to 0, the text will extend until the width is this value.

Data type: Float

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 object. 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

Others
Data Mapping File Specifies the data mapping file to the object for NLS use.

For example, if the data mapping file name is Category_de_DE.properties, set the value as Category (without the language and locale part).

Data type: String

Enable Hyperlink in Excel Specifies whether to enable the link defined on the object when exporting the report to an Excel file.

Data type: Boolean

Enable Hyperlink in HTML Specifies whether to enable the link defined on the object when exporting the report to an HTML file.

Data type: Boolean

Enable Hyperlink in PDF Specifies whether to enable the link defined on the object when exporting the report to a PDF file.

Data type: Boolean

Export to CSV Specifies whether to include the object when exporting the report to CSV.

Data type: Boolean

Export to Excel Specifies whether to include the object when exporting the report to Excel.

Data type: Boolean

Invisible Specifies whether to show the object in the design area and in the report results. All formulas and calculations will still be performed if the property is set to true.

Data type: Boolean

Link Specifies to link the object to another report, a website, an e-mail address or a Blob data type field. Click in the value cell to set the link target. For details, see Binding a link to a label.

Data type: String

Logic Column Specifies whether to show the object in the next visible table cell in the same row when the column which holds the object is hidden. Choose an option from the drop-down list.

Data type: Enumeration

Notes:

  • The next visible table cell should be completely empty, that is, the cell should not hold any content including blank space.
  • When the property for several objects in the same row is set to next visible column, and the columns holding these objects are all hidden, then only the object in the rightmost column will be shown in the next visible cell.
Parameter Substitutes the current parameter with another one by selecting from the drop-down list.

To make the property editable, uncheck Forbid changing parameter in the Options dialog (File > Options > Panel > Forbid changing parameter).

Data type: String

Position Specifies the position of the object. Choose an option from the drop-down list.
  • static - The object is positioned at the location in which it is inserted. If selected, the X, Y and other position-related properties will be hidden or disabled. The position of the object is affected by preceding objects in the same container.
  • absolute - The object will be located at the position specified by dragging and dropping or by setting its X and Y property values. The position of the object is not affected by preceding objects in the same container.

Data type: Enumeration

Note: This property only affects objects with a parent container that is the report body, a table cell, a tabular cell, or a text box.
Record Location Specifies the calculation point for the properties which use formulas. Choose an option from the drop-down list.
  • Default - The values of the properties are calculated in the default location where they are located.
  • Page Header - The values of the properties are calculated in the page header.
  • Page Footer - The values of the properties are calculated in the page footer.

Data type: Enumeration

Suppress Specifies whether to show the object in the design area and in the report results. All formulas and calculations will be skipped if the property is set to true. Not supported in Web Report Studio.

Data type: Boolean

Note: When both the Invisible and Suppress properties of an object are set to true, Suppress has the higher priority.
Suppress When No Records Specifies whether to display the object in the report results when no record is returned to its parent data container. Not supported in Web Report Studio.

Data type: Boolean
Suppress When Null If true and its value is null, the field will not be displayed.

Data type: Boolean

Transfer Style Specifies whether the style group of the primary report will be applied to the linked report if the object is linked to a report.

Data type: Boolean

Value Delimiter Specifies the separator for the data whose type is DBArray.

The default value space means that the elements will be displayed in a horizontal line and separated by a space.

Data type: String