Skip to main content

Properties of Parameter Control in Web Report

  • Updated

Previous Topic  Next Topic

Properties of Parameter Control in Web Report

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

Property NameDescription
Geometry
HeightSpecifies the height of the object. Enter a numeric value to change the height.

Data type: Float

WidthSpecifies the width of the object. Enter a numeric value to change the width.

Data type: Float

XSpecifies 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

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

ForegroundSpecifies 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
ClassSpecifies a CSS class to be applied to the object which is a valid class in the CSS file.

Data type: String

IDSpecifies the identifier of the object, which must be unique in the report. The ID property can be a style sheet selector.

Data type: String

StyleThe 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 IndexSpecifies 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 IndexSpecifies 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 ColorSpecifies 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 ThicknessSpecifies the width of the border. Enter a numeric value to change the thickness.

Data type: Float

Bottom LineSpecifies the line style of the bottom border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Left LineSpecifies the line style of the left border of the object. Choose a style from the drop-down list.

Data type: Enumeration

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

Data type: Enumeration

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

Data type: Boolean

Shadow ColorSpecifies 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 LineSpecifies the line style of the top border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Pattern
Pattern ColorSpecifies 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 StyleSpecifies 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
BoldSpecifies 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

FormatSpecifies 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

ItalicSpecifies 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 AppletSpecifies whether to include the object when exporting the report to Applet.

Data type: Boolean

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

Data type: Boolean

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

Data type: Boolean

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

Data type: Boolean

Export to PDFSpecifies whether to include the object when exporting the report to PDF.

Data type: Boolean

Export to PostScriptSpecifies whether to include the object when exporting the report to PostScript.

Data type: Boolean

Export to Report ResultSpecifies whether to include the object when exporting the report to Report Result.

Data type: Boolean

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

Data type: Boolean

Export to TextSpecifies 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

InvisibleSpecifies 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

ParameterSpecifies the value of the parameter.

Data type: String

PositionSpecifies 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

Previous Topic  Next Topic