Skip to main content

Parameter Control Properties

  • Updated

BackPrevious Topic  Next TopicNext

Parameter Control Properties

This topic describes the properties of a Parameter Control object.

Designer provides some properties only when you use the object in certain report types. You can get details from the Available For column in the property table.

Property NameAvailable ForDescription
General
Class TypeQuery Page ReportShows the class type of the object. This property is read only.
Instance Name Query Page ReportShows the instance name of the object. This property is read only.
Geometry
HeightPage Report, Web Report, Library ComponentSpecifies the height of the object. Type a numeric value to change the height.

Data type: Float

WidthPage Report, Web Report, Library ComponentSpecifies the width of the object. Type a numeric value to change the width.

Data type: Float

XPage Report, Web Report, Library ComponentSpecifies the horizontal coordinate of the object's top left corner, relative to its parent container, which Logi Report Engine applies when the object is not in static position in the container. Type a numeric value to change the coordinate.

Data type: Float

YPage Report, Web Report, Library ComponentSpecifies the vertical coordinate of the object's top left corner, relative to its parent container, which Logi Report Engine applies when the object is not in static position in the container. Type a numeric value to change the coordinate.

Data type: Float

Color
BackgroundPage Report, Web Report, Library ComponentSpecifies the background color of the object. Choose a color from the drop-down list or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

ForegroundPage Report, Web Report, Library ComponentSpecifies the foreground color of the object. Choose a color from the drop-down list or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

CSS
ClassPage Report, Web Report, Library ComponentSpecifies the name of the Class Selector to apply to the object, which you define in the CSS file of the style the report applies.

For example, if you define the CSS file as follows:

@charset "GBK";
TextField {Background: #ff0000}
/*Style=LabelX*/
TextField[Style="LabelX"]{Background: #0000FF}
/*ID=W*/
TextField#W{Background: #FFFF00}
/*class=C*/
TextField.C{Background: #00FFFF}

To apply the Class Selector in the file to the object, type C in the value cell.

Data type: String

IDPage Report, Web Report, Library ComponentSpecifies the name of the ID Selector to apply to the object, which you define in the CSS file of the style the report applies. For example, to apply the ID Selector in the preceding sample CSS file to the object, type W in the value cell.

Data type: String

StylePage Report, Web Report, Library ComponentSpecifies the style you want to apply to the object. You can specify the style in two ways:
  • Type the style which should be an Attribute Selector whose attribute is "style" in the CSS file of the style the report applies. For example, to apply the style in the preceding sample CSS file to the object, type LabelX in the value cell.
  • Choose a style from the drop-down list if you have specified the Style Group property for the report tab or web report, and there are styles in the style group that are applicable to the object.

Data type: String

Excel
Column IndexPage Report, Web ReportSpecifies the X coordinate of the object relative to its parent container in the Excel and CSV outputs, measured in cells. This property takes effect when you set Columned of the page report tab or web report to "true" and Position of the object is not "static".

Data type: Integer

Row IndexPage Report, Web ReportSpecifies the Y coordinate of the object relative to its parent container in the Excel and CSV outputs, measured in cells. This property takes effect when you set Columned of the page report tab or web report to "true" and Position of the object is not "static".

Data type: Integer

Border
Border ColorQuery Page Report, Web Report, Library ComponentSpecifies the color for the border of the object. Choose a color from the drop-down list or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border ThicknessQuery Page Report, Web Report, Library ComponentSpecifies the width for the border of the object. Type a numeric value to change the thickness.

Data type: Float

Bottom LineQuery Page Report, Web Report, Library ComponentSpecifies the line style for the bottom border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Left LineQuery Page Report, Web Report, Library ComponentSpecifies the line style for the left border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Right LineQuery Page Report, Web Report, Library ComponentSpecifies the line style for the right border of the object. Choose an option from the drop-down list.

Data type: Enumeration

ShadowQuery Page Report, Web Report, Library ComponentSpecifies whether to add a drop shadow effect to the border.

Data type: Boolean

Shadow ColorQuery Page Report, Web Report, Library ComponentSpecifies the color of the border shadow. Choose a color from the drop-down list or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Top LineQuery Page Report, Web Report, Library ComponentSpecifies the line style for the top border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Pattern
Pattern ColorPage Report, Web Report, Library ComponentSpecifies 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 in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Pattern StylePage Report, Web Report, Library ComponentSpecifies the style of the pattern. Choose an option from the drop-down list.
  • none
    Select if you do not want to apply a pattern to the object.
  • 50%
    Select to fill the object using 50%-transparency of the specified pattern color.
  • horizontal
    Select to fill the object with horizontal lines using the specified pattern color.
  • vertical
    Select to fill the object with vertical lines using the specified pattern color.
  • grid
    Select to fill the object with grids using the specified pattern color.
  • diagonal
    Select to fill the object with diagonal lines using the specified pattern color.

Data type: String

Text Format
Auto Scale in NumberPage Report, Web Report, Library ComponentDesigner displays this property when the parameter in the parameter control is Number data type. You can use it to specify whether to automatically scale the Number values that fall into the two ranges:
  • When 1000 <= value < 10^15, Logi Report Engine applies the following quantity unit symbols of the International System of Units 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, Logi Report Engine uses scientific notation to scale the values.

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

Data type: Boolean

BoldPage Report, Web Report, Library ComponentSpecifies whether to apply bold formatting to the text in the object.

Data type: Boolean

Convert HTML TagQuery Page Report

Specifies whether to parse the HTML tag elements that are included in the text of the object as the web browser translates them into HTML in the report.

Data type: Boolean

Note icon

  • This property takes effect when you set Position of the object to "absolute".
  • This property does not work when you view or export the report in the Page Report Result or Logi Report Result format.
Font Face Page Report, Web Report, Library ComponentSpecifies the font face of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration

Font Size Page Report, Web Report, Library ComponentSpecifies the font size of the text in the object. Type an integer value to change the size.

Data type: Integer

FormatPage Report, Web Report, Library ComponentSpecifies the format in which you want to display values of the object in the report. Choose an option from the drop-down list or type the format by yourself.

Data type: String

Note icon

  • If the object is BigDecimal data type, to avoid precision loss, you should specify a prefix JRD when setting the format.
  • If the object is Number data type and you set its Auto Scale in Number property to "true", Logi Report Engine applies the specified format to the integer part of the values after scaling them; however, if the specified format conflicts with the Auto Scale in Number property (for example, the values display in percentage), Logi Report Engine ignores the Auto Scale in Number property.
Horizontal Alignment Page Report, Web Report, Library ComponentSpecifies the horizontal justification of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration

ItalicPage Report, Web Report, Library ComponentSpecifies whether to italicize the text in the object.

Data type: Boolean

Underline Page Report, Web Report, Library ComponentSpecifies whether to add a horizontal line under the text in the object.

Data type: Boolean

Vertical Alignment Page Report, Web Report, Library ComponentSpecifies the vertical justification of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration

Others
Export as TextPage Report, Web Report, Library ComponentSpecifies whether to export the parameter control as text.

When this property is "true", depending on properties of the parameter in the parameter control, Logi Report Engine exports it as follows:

  • The selected values or text of the parameter are exported as text while the button for specifying the parameter value is not exported.
  • If the parameter in the parameter control is of Boolean type, it displays as a checkbox in the parameter control, then when the checkbox is selected, it is exported as Checkmark and if cleared, as Checkbox.

When this property is "false", Logi Report Engine exports the parameter control as an image.

Data Type: Boolean

Export to CSVPage Report, Web Report, Library ComponentSpecifies whether to include the object in the CSV output.

Data type: Boolean

Export to ExcelPage Report, Web Report, Library ComponentSpecifies whether to include the object in the Excel output.

Data type: Boolean

Export to HTMLPage Report, Web Report, Library ComponentSpecifies whether to include the object in the HTML output.

Data type: Boolean

Export to PDFPage Report, Web Report, Library ComponentSpecifies whether to include the object in the PDF output.

Data type: Boolean

Export to PostScriptPage Report, Web Report, Library ComponentSpecifies whether to include the object in the PostScript output.

Data type: Boolean

Export to Report ResultPage Report, Web Report, Library ComponentSpecifies whether to include the object when you preview the report in the Page Report Result format for a page report or Web Report Result for a web report in Designer, and when users run the report in the same format or use the library component at runtime.

Data type: Boolean

Export to RTF Page Report, Web Report, Library ComponentSpecifies whether to include the object in the RTF output.

Data type: Boolean

Export to TextPage Report, Web Report, Library ComponentSpecifies whether to include the object in the Text output.

Data type: Boolean

Export to XML Page Report, Web Report, Library ComponentSpecifies whether to include the object in the XML output.

Data type: Boolean

InvisiblePage Report, Web Report, Library ComponentSpecifies whether to hide the object in the design area and in the report. Logi Report Engine performs all calculations that involve the object regardless of whether the object is visible or not.

Data type: Boolean

ParameterPage Report, Web Report, Library ComponentSpecifies the value of the parameter.

Data type: String

PositionPage Report, Web Report, Library ComponentDesigner enables this property when the object is in a flow layout container, such as the report body or a tabular cell, text box, or KPI. You can use it to specify the position of the object in the container. Choose an option from the drop-down list.

Data type: Enumeration

Accessibility
External CSS Class SelectorQuery Page ReportSpecifies the name of the Class Selector for the object in the HTML output.

Data type: String

External StyleQuery Page ReportThis property is mapped to the HTML attribute style, as specified by w3.org.

Data type: String

External TitleQuery Page ReportThis property is mapped to the HTML attribute title, as specified by w3.org.

Data type: String

LanguageQuery Page ReportThis property is mapped to the HTML attribute lang, as specified by w3.org.

Data type: String

Tag NamePage Report, Web Report, Library ComponentSpecifies the header tag name of the object for labeling its heading order in the accessible PDF output. Choose an option from the drop-down list.

When setting this property, you should nest the headers properly based on the following rules so that Adobe can accept the heading tag sequence.

  • H1 should always be the first heading tag.
  • The descending sequence of the headers should follow the downward order of the objects in the Report Inspector.
  • The descending sequence of the headers should proceed in strict numerical order and should not skip an intervening heading level. H1 H2 H3 is permissible, while H1 H3 is not.

Data type: Enumeration

BackPrevious Topic  Next TopicNext