Skip to main content

Parameter Control

  • Updated

BackPrevious Topic  Next TopicNext

Parameter Control

The properties of Parameter Control object are:

Property NameDescription
General
Display NameSpecifies the display name of the object.

Data type: String

Instance NameShows the instance name of the object. This property is read only.
Geometry
HeightSpecifies the height of the object, in inches. Type a numeric value to change the height.

Data type: Float

WidthSpecifies the width of the object, in inches. Type 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 unavailable if the Position property is set to static. Type a numeric value to change the position in inches.

Data type: Float

YSpecifies the vertical coordinate of the top left corner of the object, relative to its parent container. This property is unavailable if thePositionproperty is set to static. Type a numeric value to change the position in inches.

Data type: Float

Color
BackgroundSpecifies the background color of the object. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog box. You can also type 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 define a color in the Color Picker dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Text Format
Auto Scale in NumberThe property is available when the parameter added in the object is of the Number data type. It specifies whether to automatically scale the parameter values that fall into the two ranges:
  • When 1000 <= value < 10^15, the following quantity unit symbols of the International System of Units are used to scale the values: K (10^3), M (10^6), G (10^9), and T (10^12).
  • When 0 < value < 0.001 or value >= 10^15, scientific notation is used to scale the values.

The option "auto" means that the property setting follows that of the object's parent data container.

Data type: Boolean

BoldSpecifies whether to make the text bold.

Data type: Boolean

Font FaceSpecifies the font of the text. Choose an option from the drop-down list.

Data type: Enumeration

Font SizeSpecifies the font size of the text. Type 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

Notes:

  • For the BigDecimal data type, to avoid precision loss, you should type a prefix JRD when setting the Format property value.
  • For the Number data type and when the Auto Scale in Number property is true, the Format property applies to the integer part of the values after scaled, but if the specified format conflicts with the Auto Scale in Number property, for example, the values are displayed in percentage, then the Auto Scale in Number property is ignored.
Horizontal AlignmentSpecifies 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

UnderlineSpecifies whether to underline the text.

Data type: Boolean

Vertical AlignmentSpecifies the vertical justification of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration

Border
Border ColorSpecifies the color of the border of the object. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border ThicknessSpecifies the width of the border in inches. Type 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

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

Data type: Enumeration

Padding
Bottom PaddingSpecifies the space between the text of the parameter control and its bottom border.

Data type: Float

Left PaddingSpecifies the space between the text of the parameter control and its left border.

Data type: Float

Right PaddingSpecifies the space between the text of the parameter control and its right border.

Data type: Float

Top PaddingSpecifies the space between the text of the parameter control and its top border.

Data type: Float

Others
Export as Text Specifies whether to export the parameter control as text. If this option is unselected, the parameter control will be exported as an image.

When Export as Text is enabled, depending on the properties of the parameter bound in the parameter control, Logi Report will export the parameter control as follows:

  • The selected values or text of the parameter will be exported as text while the icon or button for specifying the parameter value not exported.
  • If the parameter in the parameter control is of Boolean type, Report Server displays it as a check box in the parameter control. Then when the check box is selected, it will be exported as Checkmark and if unselected as Checkbox.

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 in Web Report Studio or when the report is opened in Web Report Result.

Data type: Boolean

Export to RTFSpecifies 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 XMLSpecifies whether to include the object when exporting the report to XML.

Data type: Boolean

InvisibleSpecifies whether to show or hide the object. All formulas and calculations will still be performed if the property is set to true. You can also use a formula to control whether or not to show the object.

Data type: Boolean

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

BackPrevious Topic  Next TopicNext

Related articles