BackPrevious Topic Next TopicNext

Parameter Field Properties

This topic lists the properties of a Parameter Field 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
Data Type Query Page Report Shows the data type of the parameter. This property is read only.
Default Value Query Page Report Shows the default value of the parameter. This property is read only.
Field Type Query Page Report Shows what kind of field it is. This property is read only.
Instance Name Query Page Report Shows the instance name of the object. This property is read only.
Parameter Name Page Report, Web Report, Library Component Shows the name of the parameter. This property is read only.
Geometry
Height Page Report, Web Report, Library Component Specifies the height of the object. Type a numeric value to change the height.

Data type: Float

Width Page Report, Web Report, Library Component Specifies the width of the object. Type 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. Type 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. Type 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 type 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 type 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. A String type value.
Style Page Report, Web Report, Library Component 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 page report tab or web report or library component 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. Type a valid class name from the CSS file.

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

Padding
Bottom Padding Page Report, Web Report, Library Component Specifies the space between the text and the bottom border of the object. Type a numeric value to change the padding.

Data type: Float

Left Padding Page Report, Web Report, Library Component Specifies the space between the text and the left border of the object. Type a numeric value to change the padding.

Data type: Float

Right Padding Page Report, Web Report, Library Component Specifies the space between the text and the right border of the object. Type a numeric value to change the padding.

Data type: Float

Top Padding Page Report, Web Report, Library Component Specifies the space between the text and the top border of the object. Type a numeric value to change the padding.

Data type: Float

Border
Border Color 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 type 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 Page Report, Web Report, Library Component Specifies the width of the border. Type a numeric value to change the thickness.

Data type: Float

Bottom Line 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 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 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 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 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 type 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 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 type 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 Fit Page Report, Web Report, Library Component Specifies whether to adjust the width and height of the object according to the contents.

Data type: Boolean

Auto Scale in Number Page Report, Web Report, Library Component The property is available when the object is of the Number data type. It specifies whether to automatically scale the object 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

Bold Page Report, Web Report, Library Component Specifies whether to make the text bold.

Data type: Boolean

Convert HTML Tag Query Page Report Specifies whether or not to parse the HTML tag elements that are written in the text of the object in the report result.
  • true - Logi Report Engine will parse the HTML tag elements in the report result.
  • false - HTML tag elements will not be parsed in the report result.

This property takes effect when the object's Position property is set to absolute.

Note: The property does not work when viewing or exporting the report in the Page Report Result or Logi Report Result format.

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. Type 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:

  • For the BigDecimal data type, to avoid precision loss, you should specify 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 specified format 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 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

Ignore HTML Tag Query Page Report Specifies whether or not to ignore the HTML tag elements that are written in the text of the object in the HTML result of the report.
  • true - HTML tag elements in the text will not be parsed.
  • false - HTML tag elements in the text will be transferred as they are translated into HTML by the web browser.

Data type: Boolean

Italic Page Report, Web Report, Library Component Specifies whether to make the text italic.

Data type: Boolean

Maximum Width Page Report, Web Report, Library Component Specifies the maximum width of the text displayed. Type a numeric value to change the width.

This property often works with the Auto Fit property. If Auto Fit = true and Maximum Width is not equal to 0, the text will extend until the width is this value.

Data type: Float

Strikethrough Page Report, Web Report, Library Component Specifies whether to add a strikethrough line to the text.

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

Word Wrap Page Report, Web Report, Library Component Specifies whether to wrap the text to the width.

Data type: Boolean

Others
Data Mapping File Page Report, Web Report, Library Component Specifies the data mapping file to the object for NLS use.

For example, if the data mapping file name is Category_de_DE.properties, set the value as Category (without the language and locale part).

Data type: String

Detail Report Query Page Report Specifies the detail report that the object is linked to. Select in the value cell to set the detail report. For details, refer to Linking to a Detail Report.

Data type: Boolean

Detail Target Frame Page Report Specifies the target window or frame in which to display the detailed information. Choose an option from the drop-down list. This property is supported on parameter fields in the group header/footer panel of a banded object and enabled when Go to Detail is set to true.

Data type: String

Display Null Page Report, Web Report, Library Component Specifies the string to be displayed if the field value is null.

Data type: String

Enable Hyperlink in Excel Page Report, Web Report, Library Component Specifies whether to enable the link defined on the object in the Excel result of the report.

Data type: Boolean

Enable Hyperlink in HTML Page Report, Web Report, Library Component Specifies whether to enable the link defined on the object in the HTML result of the report.

Data type: Boolean

Enable Hyperlink in PDF Page Report, Web Report, Library Component Specifies whether to enable the link defined on the object in the PDF result of the report.

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. If it is set to true in page report, only the string value will be included when the object is displayed as a barcode or text field, and only the text will be included when the object is displayed as a check box, radio button or button.

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. If it is set to true in page report, only the string value will be included when the object is displayed as a text field.

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. If it is set to true in page report, only the string value will be included when the object is displayed as a text field.

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. If it is set to true in page report, only the string value will be included when the object is displayed as a text field.

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. If it is set to true in page report, only the string value will be included when the object is displayed as a text field, and only the text will be included when the object is displayed as a radio button or button.

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. If it is set to true in page report, only the string value will be included when the object is displayed as a barcode or text field, and only the text will be included when the object is displayed as a check box, radio button or button.

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. If it is set to true in page report, only the string value will be included when the object is displayed as a barcode or text field, and only the text will be included when the object is displayed as a check box, radio button or button.

Data type: Boolean

Go to Detail Query Page Report Specifies whether to show the detailed information when you select the object in Page Report Studio. This property is available only when the object is in the group header/footer panel of a banded object. For details about its usage, refer to Obtaining Detailed Information from a Banded Object.

Data type: Boolean

Invisible Page Report, Web Report, Library Component Specifies whether to show the object in the design area and in the report result. All formulas and calculations will still be performed if the property is set to true.

Data type: Boolean

Link Page Report, Web Report, Library Component Specifies to link the object to another report, a website, an e-mail address or a Blob data type field. Select in the value cell to set the link target. For details, see Adding Links in Reports.

Data type: String

Logic Column Page Report, Web Report, Library Component Specifies whether to show the object in the next visible table cell in the same row when the column which holds the object is hidden. This property is supported when the object is in a table. Choose an option from the drop-down list.

Data type: Enumeration

Notes:

  • The next visible table cell should be completely empty, that is, the cell should not hold any content including blank space.
  • When the property for several objects in the same row is set to next visible column, and the columns holding these objects are all hidden, then only the object in the rightmost column will be shown in the next visible cell.
Parameter Page Report, Web Report, Library Component Substitutes the current parameter with another one by selecting from the drop-down list.

To make the property editable, clear Forbid changing parameter in the Options dialog (File > Options > Panel > Forbid changing 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

Record Location Page Report, Web Report, Library Component Specifies the calculation point for the properties of the object which are controlled by formulas. Choose an option from the drop-down list.
  • Default - The values of the properties are calculated in the default location where they are located.
  • Page Header - The values of the properties are calculated in the page header.
  • Page Footer - The values of the properties are calculated in the page footer.

Data type: Enumeration

Suppress Page Report, Web Report, Library Component Specifies whether to show the object in the design area and in the report result. All formulas and calculations will be skipped if the property is set to true. Not supported in Web Report Studio.

Data type: Boolean

Note: When both the Invisible and Suppress properties of an object are set to true, Suppress has the higher priority.

Suppress When No Records Page Report, Web Report, Library Component Specifies whether to display the object in the report result when no record is returned to its parent data component. Not supported in Web Report Studio.

Data type: Boolean

Suppress When Null Page Report, Web Report, Library Component If true and its value is null, the field will not be displayed.

Data type: Boolean

Transfer Style Page Report, Web Report, Library Component Specifies whether the style group of the primary report will be applied to the linked report if the object is linked to a report.

Data type: Boolean

Value Delimiter Page Report, Web Report, Library Component Specifies the separator for the data whose type is DBArray.

The default value space means that the elements will be displayed in a horizontal line and separated by a space.

Data type: String

TOC (supported on parameters in a banded object)
Anchor Display Value Query Page Report Specifies a string or formula to display for the TOC entry for this object in the TOC Browser. By default it is the value of the specified object. The TOC Anchor property must be set to true for this property to take effect.

Data type: String

TOC Anchor Query Page Report Specifies whether to include the object in the TOC Browser for the report.

Data type: Boolean

Accessibility
External AccessKey Query Page Report It is mapped to the HTML attribute accesskey. This attribute specifies an access key to the object.

Data type: String

External CSS Class Selector Query Page Report Specifies a class selector to be applied to the object when exported as HTML. Type a valid class name from the CSS file.

Data type: String

External Dir Query Page Report It is mapped to the HTML attribute dir. This attribute specifies the base direction of directionally neutral text in the object's content and attribute values. It also specifies the directionality of tables. Possible values:
  • LTR - Left-to-right text or table.
  • RTL - Right-to-left text or table.

Data type: String

External ID Query Page Report It is mapped to the HTML attribute id. This attribute specifies a name to the object, which must be unique in the report.

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 TabIndex Query Page Report It is mapped to the HTML attribute tabindex. This attribute specifies the position of the object in the tabbing order for the current report. Type an integer equal to or greater than 0 and less than 65535.

Data type: Integer

HrefLang Query Page Report It is mapped to the HTML attribute hreflang. This attribute specifies the base language of the resource designated by a link and may only be used when a link is specified.

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

This image notes any new content for version 17 of the product. For more information please see the Release Notes or What's New topics.Tag Name Page Report, Web Report, Library Component

It specifies the header tag name of the object used for labeling the heading order of the object in the PDF result for accessibility.

When setting the property, you should make sure that the headers are nested properly following the rules below so that the heading tag sequence can be accepted by Adobe.

  • If any heading tags are used, H1 should be the first.
  • 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

Back to top

BackPrevious Topic Next TopicNext