Previous Topic
Parameter Control Properties
This topic lists the properties of a Parameter Control object. The availabilities of the properties vary for the supported report types: Page Report, Web Report and Library Component.
| Property Name | Available For | Description |
|---|---|---|
| General | ||
| Class Type | Query Page Report | Indicates the class type of the object. This property is read only. |
| Instance Name | Query Page Report | Shows the instance name of the object. This property is read only. |
| Geometry | ||
| Height | Page Report, Web Report, Library Component | Specifies the height of the object. Enter a numeric value to change the height.
Data type: Float |
| Width | Page Report, Web Report, Library Component | Specifies the width of the object. Enter a numeric value to change the width.
Data type: Float |
| X | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | Specifies the background color of the object. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Foreground | Page Report, Web Report, Library Component | Specifies the foreground color of the object. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| CSS | ||
| Class | Page Report, Web Report, Library Component | Specifies a CSS class to be applied to the object which is a valid class in the CSS file.
Data type: String |
| ID | Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | The property can be used in two ways.
Data type: String |
| Excel | ||
| Column Index | Page Report, Web Report | 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 page report tab or web report level must be set to true for this property to take effect.
Data type: Integer |
| Row Index | Page Report, Web Report | 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 page report tab or web report level must be set to true for this property to take effect.
Data type: Integer |
| Border | ||
| Border Color | Query Page Report, Web Report, Library Component | Specifies the color of the border of the object. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Border Thickness | Query Page Report, Web Report, Library Component | Specifies the width of the border. Enter a numeric value to change the thickness.
Data type: Float |
| Bottom Line | Query Page Report, Web Report, Library Component | Specifies the line style of the bottom border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
| Left Line | Query Page Report, Web Report, Library Component | Specifies the line style of the left border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
| Right Line | Query Page Report, Web Report, Library Component | Specifies the line style of the right border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
| Shadow | Query Page Report, Web Report, Library Component | Specifies whether to draw two shadowed borders, beneath and to the right of the object.
Data type: Boolean |
| Shadow Color | Query Page Report, Web Report, Library Component | Specifies the color of the shadow. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Top Line | Query Page Report, Web Report, Library Component | 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 | Page Report, Web Report, Library Component | 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, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Pattern Style | Page Report, Web Report, Library Component | Specifies the style of the pattern. Choose an option from the drop-down list.
Data type: Enumeration |
| Text Format | ||
| Auto Scale in Number | Page Report, Web Report, Library Component | The 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:
The option "auto" means that the property setting follows that of the object's parent data container. Data type: Boolean |
| Bold | Page Report, Web Report, Library Component | Specifies whether to make the text bold.
Data type: Boolean |
| Font Face | Page Report, Web Report, Library Component | Specifies the font of the text. Choose an option from the drop-down list.
Data type: Enumeration |
| Font Size | Page Report, Web Report, Library Component | Specifies the font size of the text. Enter an integer value to change the size.
Data type: Integer |
| Format | Page Report, Web Report, Library Component | Specifies the display format of the text in the report result. It varies with data type and can be manually defined.
Data type: String Notes:
|
| Horizontal Alignment | Page Report, Web Report, Library Component | Specifies the horizontal justification of the text in the object. Choose an option from the drop-down list.
Data type: Enumeration |
| Italic | Page Report, Web Report, Library Component | Specifies whether to make the text italic.
Data type: Boolean |
| Underline | Page Report, Web Report, Library Component | Specifies whether to underline the text.
Data type: Boolean |
| Vertical Alignment | Page Report, Web Report, Library Component | Specifies the vertical justification of the text in the object. Choose an option from the drop-down list.
Data type: Enumeration |
| Others | ||
| Export as Text | Page Report, Web Report, Library Component | Specifies whether to export the parameter control as text. If this option is unchecked, 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 JReport will export the parameter control as follows:
Data Type: Boolean |
| Export to CSV | Page Report, Web Report, Library Component | Specifies whether to include the object in the CSV result of the report.
Data type: Boolean |
| Export to Excel | Page Report, Web Report, Library Component | Specifies whether to include the object in the Excel result of the report.
Data type: Boolean |
| Export to HTML | Page Report, Web Report, Library Component | Specifies whether to include the object in the HTML result of the report.
Data type: Boolean |
| Export to PDF | Page Report, Web Report, Library Component | Specifies whether to include the object in the PDF result of the report.
Data type: Boolean |
| Export to PostScript | Page Report, Web Report, Library Component | Specifies whether to include the object in the PostScript result of the report.
Data type: Boolean |
| Export to Report Result | Page Report, Web Report, Library Component | Specifies whether to include the object when previewing the report in Page/Web Report Result and running the report in Page/Web Report Studio, or when the library component is used in JDashboard.
Data type: Boolean |
| Export to RTF | Page Report, Web Report, Library Component | Specifies whether to include the object in the RTF result of the report.
Data type: Boolean |
| Export to Text | Page Report, Web Report, Library Component | Specifies whether to include the object in the Text result of the report.
Data type: Boolean |
| Export to XML | Page Report, Web Report, Library Component | Specifies whether to include the object in the XML result of the report.
Data type: Boolean |
| Invisible | Page Report, Web Report, Library Component | Specifies whether to show the object in the design area and in the results. All formulas and calculations will still be performed if the property is set to true.
Data type: Boolean |
| Parameter | Page Report, Web Report, Library Component | Specifies the value of the parameter.
Data type: String |
| Position | Page Report, Web Report, Library Component | Specifies the position of the object. Choose an option from the drop-down list.
Data type: Enumeration |
| Accessibility | ||
| External CSS Class Selector | Query Page Report | Specifies a class selector to be applied to the object when exported as HTML. Enter a valid class name from the CSS file.
Data type: String |
| External Style | Query Page Report | It is mapped to the HTML attribute style. This attribute specifies style information for the object.
Data type: String |
| External Title | Query Page Report | It is mapped to the HTML attribute title. This attribute offers advisory information about the object.
Data type: String |
| Language | Query Page Report | It is mapped to the HTML attribute lang. This attribute specifies the base language of the object's attribute values and text content.
Data type: String |
and if unchecked as 
.