Skip to main content

Parameter Field Properties

  • Updated

BackPrevious Topic  Next TopicNext

Parameter Field Properties

This topic describes the properties of a Parameter Field 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
Data TypeQuery Page ReportShows the data type of the parameter. This property is read only.
Default ValueQuery Page ReportShows the default value of the parameter. This property is read only.
Field TypeQuery Page ReportShows what kind of field it is. This property is read only.
Instance Name Query Page ReportShows the instance name of the object. This property is read only.
Parameter NamePage Report, Web Report, Library ComponentShows the name of the parameter. 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

Padding
Bottom PaddingPage Report, Web Report, Library ComponentSpecifies the space between the content in the object and the bottom border of the object. Type a numeric value to change the padding.

Data type: Float

Left PaddingPage Report, Web Report, Library ComponentSpecifies the space between the content in the object and the left border of the object. Type a numeric value to change the padding.

Data type: Float

Right PaddingPage Report, Web Report, Library ComponentSpecifies the space between the content in the object and the right border of the object. Type a numeric value to change the padding.

Data type: Float

Top PaddingPage Report, Web Report, Library ComponentSpecifies the space between the content in the object and the top border of the object. Type a numeric value to change the padding.

Data type: Float

Border
Border ColorPage 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 ThicknessPage 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 LinePage 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 LinePage 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 LinePage 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

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

Data type: Boolean

Shadow ColorPage 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 LinePage 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 Fit Page Report, Web Report, Library ComponentSpecifies whether to automatically adjust the width and height of the object according to its content.

Data type: Boolean

Auto Scale in NumberPage Report, Web Report, Library ComponentDesigner displays this property when the object is Number data type. You can use it to specify whether to automatically scale values of the object 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 Tag Query 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 has higher priority than Ignore HTML Tag.
  • This property does not work when you view or export the report in the Page Report Result or Logi Report Result format.
  • This property takes effect when you set Position of the object to "absolute".
Font FacePage 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 SizePage 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.
Format LocalePage Report, Web Report, Library ComponentSpecifies the locale for displaying and formatting values of the object when its data type is locale sensitive, such as the date and time formats, and number and currency formats. Default is the locale of your JVM or the language of the NLS report. Choose an option from the drop-down list if you want to change the locale.

Data type: String

Note icon When you use a formula or edit an expression to control the locale, the return value should be the two-letter language and country codes as defined by ISO-639 and ISO-3166 in the format language_country, for example, de_DE.

Horizontal AlignmentPage 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

Ignore HTML TagPage Report, Web Report, Library ComponentSpecifies whether to ignore the HTML tag elements that are included in the text of the object at runtime and in HTML output, so they display exactly as what they are. When you set this property to "false", Logi Report Engine transfers the HTML tag elements to the web browser and they are translated into HTML by the web browser.

Data type: Boolean

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

Data type: Boolean

Maximum WidthPage Report, Web Report, Library ComponentSpecifies the maximum width of the text you want to display in the object. Type a numeric value to change the width.

This property often works together with Auto Fit. When you set Auto Fit of the object to "true" and the value of Maximum Width is not equal to 0, the text extends in the object until the width is this value.

Data type: Float

Reduce Width When Auto FitPage Report, Web Report, Library ComponentSpecifies whether to reduce the width of the object according to its content when you specify to automatically adjust its width (the object's Auto Fit being "true") and the actual width of the content is smaller than that of the object. This property takes effect when you set Position of the object to "absolute"; but, it does not work if the Word Wrap property of the object is "true".

Data type: Boolean

StrikethroughPage Report, Web Report, Library ComponentSpecifies whether to draw a line through the text in the object.

Data type: Boolean

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

Data type: Boolean

Vertical AlignmentPage 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

Word WrapPage Report, Web Report, Library ComponentSpecifies whether to wrap the text according to the width of the object.

Data type: Boolean

Others
Data Mapping FilePage Report, Web Report, Library ComponentSpecifies the data mapping file you want to apply 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 locale part).

Data type: String

Detail ReportQuery Page ReportSpecifies the detail report that you want to link the object to. Select the ellipsis Ellipsis button in the value cell to set the detail report. For more information, see Linking to a Detail Report.

Data type: String

Detail Target FrameQuery Page ReportDesigner displays this property when the object is in the group header/footer panel of a banded object, and enables it after you set Go to Detail of the object to "true". You can use it to specify the target window or frame to display the detail information. Choose an option from the drop-down list.
  • <Server Setting>
    Select to load the detail information according to setting of the Pop up New Window for Links option in the Profile > Configure Profile > Page Report Studio > Properties > Default tab on Server.
  • New Window
    Select to load the detail information into a new window. The window is not named.
  • Whole Window
    Select to load the detail information into the full browser window.
  • Same Frame
    Select to load the detail information into the same frame as the object.
  • Parent Frame
    Select to load the detail information into the parent frame of the frame in which the object is.
  • Other Frame
    Select to load the detail information into some other specified frame. Type the name of the frame you have defined in the value cell. If the frame name does not exist, Server loads the detail information into a new window.

Data type: String

Display NullPage Report, Web Report, Library Component Specifies the string you want to display when the field value is null.

Data type: String

Enable Hyperlink in ExcelPage Report, Web Report, Library ComponentSpecifies whether to enable the link that you have added on the object in the Excel output.

Data type: Boolean

Enable Hyperlink in HTMLPage Report, Web Report, Library ComponentSpecifies whether to enable the link that you have added on the object in the HTML output.

Data type: Boolean

Enable Hyperlink in PDFPage Report, Web Report, Library ComponentSpecifies whether to enable the link that you have added on the object in the PDF output.

Data type: Boolean

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

Data type: Boolean

Note icon When you set this property of a parameter field in a query-based page report to "true", if the parameter field displays as a barcode or text field, Logi Report Engine only includes the string value in the output; if it displays as a checkbox, radio button, or button, only the text.

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

Data type: Boolean

Note icon When you set this property of a parameter field in a query-based page report to "true", if the parameter field displays as a text field, Logi Report Engine only includes the string value in the output.

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

Note icon When you set this property of a parameter field in a query-based page report to "true", if the parameter field displays as a text field, Logi Report Engine only includes the string value in the output.

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

Data type: Boolean

Note icon When you set this property of a parameter field in a query-based page report to "true", if the parameter field displays as a text field, Logi Report Engine only includes the string value in the output.

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 RTFPage Report, Web Report, Library ComponentSpecifies whether to include the object in the RTF output.

Data type: Boolean

Note icon When you set this property of a parameter field in a query-based page report to "true", if the parameter field displays as a text field, Logi Report Engine only includes the string value in the output; if it displays as a radio button or button, only the text.

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

Data type: Boolean

Note icon When you set this property of a parameter field in a query-based page report to "true", if the parameter field displays as a barcode or text field, Logi Report Engine only includes the string value in the output; if it displays as a checkbox, radio button, or button, only the text.

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

Data type: Boolean

Note icon When you set this property of a parameter field in a query-based page report to "true", if the parameter field displays as a barcode or text field, Logi Report Engine only includes the string value in the output; if it displays as a checkbox, radio button, or button, only the text.

Go to DetailQuery Page ReportDesigner displays this property when the object is in the group header/footer panel of a banded object. You can use it to specify whether to show the detail information about the group when users select the object in Page Report Studio. For more information, see Obtaining the Group Details in a Banded Object.

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

LinkPage Report, Web Report, Library ComponentSpecifies the target that you want to link the object to, which can be another report, a website, an email address, or a Blob data type field. Select the ellipsis Ellipsis button in the value cell to set the link target. For more information, see Adding Links in Reports.

Data type: String

Logic ColumnPage Report, Web Report, Library ComponentDesigner displays this property when the object is in a table. You can use it to specify whether to show the object in the next visible table cell in the same row when the column that holds the object is hidden. Choose an option from the drop-down list.

Data type: Enumeration 

Note icon

  • The next visible table cell should be completely empty, that is, the cell should not hold any content including blank space.
  • When you set this property for several objects in the same row to "next visible column", and the columns holding these objects are all hidden, only the object in the rightmost column shows in the next visible cell.
ParameterPage Report, Web Report, Library ComponentDesigner enables this property when you have cleared "Forbid changing parameter" in the Panel category of the Options dialog box. You can use it to specify another parameter to substitute the current one. Select the parameter from the drop-down list.

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

Record LocationPage Report, Web Report, Library ComponentSpecifies the calculation point for the properties of the object that are controlled by formulas. This property takes effect only when the object is in a banded object. Choose an option from the drop-down list.
  • default
    Select to calculate values of the properties in the default location where the object is placed.
  • page header
    Select to calculate values of the properties in the banded page header panel.
  • page footer
    Select to calculate values of the properties in the banded page footer panel.

For more information, see Example 2: Showing a Label on Every Page Except the Last.

Data type: Enumeration

SuppressPage Report, Web Report, Library ComponentSpecifies whether to suppress the object in the design area and in the report. If you suppress an object, Logi Report Engine skips all formulas and calculations that involve the object. This property has higher priority over Invisible.

Data type: Boolean

Note icon Web Report Studio does not support this property on the object so it is ignored at runtime.

Suppress When No RecordsPage Report, Web Report, Library ComponentSpecifies whether to suppress the object in the report when no record is returned to its parent data component.

Data type: Boolean

Note icon Web Report Studio does not support this property on the object so it is ignored at runtime.

Suppress When NullPage Report, Web Report, Library ComponentSpecifies whether to suppress the field in the report when its value is null.

Data type: Boolean

Transfer StylePage Report, Web Report, Library ComponentSpecifies whether to apply the style group of the primary report to the linked report, when the object is linked to another report.

Data type: Boolean

Value DelimiterPage Report, Web Report, Library ComponentSpecifies the separator for DBArray data. By default, Designer displays the elements in a horizontal line and separates them by a space. Type the delimiter in the value cell.

Data type: String

TOC (available when the parameter field is in a banded object)
Anchor Display ValueQuery Page ReportSpecifies the text you want to display as the object's TOC entry label. This property takes effect when you set TOC Anchor of the object to "true".

Data type: String

TOC AnchorQuery Page ReportSpecifies whether to include the object in the TOC of the report.

Data type: Boolean

Accessibility
External AccessKeyQuery Page ReportThis property is mapped to the HTML attribute accesskey, as specified by w3.org.

Data type: String

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

Data type: String

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

Data type: String

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

Data type: String

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

Data type: String

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

Data type: Integer

HrefLangQuery Page ReportThis property is mapped to the HTML attribute hreflang, as specified by w3.org. You can use it to specify the base language of the resource designated by a link on the object, such as the target you define via the Link property.

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

Related articles