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 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 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
ID Page Report, Web Report, Library Component Specifies 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 above sample CSS file to the object, type W in the value cell.

Data type: String
Style Page Report, Web Report, Library Component Specifies 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 above 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 Index Page Report, Web Report Specifies the X coordinate of the object relative to its parent container in the Excel and CSV outputs of the report, measured in cells. This property takes effect only when the Columned property of the report tab or web report is "true" and Position of the object is not "static".

Data type: Integer
Row Index Page Report, Web Report Specifies the Y coordinate of the object relative to its parent container in the Excel and CSV outputs of the report, measured in cells. This property takes effect only when the Columned property of the report tab or web report is "true" and Position of the object is not "static".

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 in the Pick a Color dialog box, or type a hexadecimal RGB value (for example, 0xff0000) to specify a color. For a page report, you can also use a formula or edit an expression to return 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.
  • 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 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 Designer 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, Designer 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, Designer 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
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 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 result.

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 only when the object's Position is "absolute".
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 format in which you want to display values of the object in the report result. 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 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 Page Report, Web Report, Library Component Specifies whether to ignore the HTML tag elements that are included in the text of the object at runtime and in the HTML output of the report, 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
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 is 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 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 language and locale part).

Data type: String

Detail Report Query Page Report Specifies the detail report that the object is linked to. Select Ellipsis button in the value cell to set the detail report. For more information, see Linking to a Detail Report.

Data type: Boolean

Detail Target Frame Query Page Report Designer 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 to "true". You can use it to specify the target window or frame in which 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 Null Page Report, Web Report, Library Component Specifies the string you want to display when the field value is null.

Data type: String
Enable Hyperlink in Excel Page Report, Web Report, Library Component Specifies whether to enable the link that you have added on the object in the Excel output of the report.

Data type: Boolean
Enable Hyperlink in HTML Page Report, Web Report, Library Component Specifies whether to enable the link that you have added on the object in the HTML output of the report.

Data type: Boolean
Enable Hyperlink in PDF Page Report, Web Report, Library Component Specifies whether to enable the link that you have added on the object in the PDF output of the report.

Data type: Boolean
Export to CSV Page Report, Web Report, Library Component Specifies whether to include the object in the CSV output 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 checkbox, 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 output 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 output of the report.

Data type: Boolean
Export to PDF Page Report, Web Report, Library Component Specifies whether to include the object in the PDF output 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 output 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 output 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 output 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 checkbox, 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 output 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 checkbox, radio button, or button.

Data type: Boolean
Go to Detail Query Page Report Designer 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

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 email address or a Blob data type field. Select Ellipsis button in the value cell to set the link target. For more information, see Adding Links in Reports.

Data type: String

Logic Column Page Report, Web Report, Library Component Designer 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 which 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.
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 box (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 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 the values of the properties in the default location where the object is placed.
  • page header - Select to calculate the values of the properties in the banded page header panel.
  • page footer - Select to calculate the 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

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 icon When you set both the Invisible and Suppress properties of an object 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 (available when the parameter field is 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
Tag Name Page Report, Web Report, Library Component Specifies the header tag name of the object for labeling its heading order in the accessible PDF output of the report. 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 the heading tag sequence can be accepted by Adobe.

  • 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

Back to top

BackPrevious Topic  Next TopicNext