BackPrevious Page Next PageNext

Parameter Control

The properties of a parameter control object in a web report are:

Property Name Description
Geometry
Height Specifies the height of the object. Enter a numeric value to change the height.

Data type: Float
Width Specifies the width of the object. Enter a numeric value to change the width.

Data type: Float
X Specifies the horizontal coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position.

Data type: Float
Y Specifies the vertical coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position.

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

Data type: String

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

Data type: String

CSS
Class Specifies a CSS class to be applied to the object which is a valid class in the CSS file.

Data type: String
ID Specifies the identifier of the object, which must be unique in the report. The ID property can be a style sheet selector.

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
Border
Border Color Specifies the color of the border of the object. Choose a color from the drop-down list or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border Thickness Specifies the width of the border. 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 or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.

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 or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.

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

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

Others
Export to Applet Specifies whether to include the object when exporting the report to Applet.

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

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

Data type: Boolean
Export to PDF Specifies whether to include the object when exporting the report to PDF.

Data type: Boolean
Export to PostScript Specifies whether to include the object when exporting the report to PostScript.

Data type: Boolean

Export to Report Result Specifies whether to include the object when previewing the report in Web Report Result or running the report in Web Report Studio.

Data type: Boolean

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

Data type: Boolean

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

Data type: Boolean
Export to XML Specifies whether to include the object when exporting the report to XML.

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

Parameter Specifies the value of the 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

BackPrevious Page Next PageNext