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. Read only. |
Default Value | Query Page Report | Shows the default value of the parameter. Read only. |
Field Type | Query Page Report | Shows what kind of field it is. Read only. |
Instance Name | Query Page Report | Shows the instance name of the object. Read only. |
Parameter Name | Page Report, Web Report, Library Component | Shows the name of the parameter. 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 object's top left corner, relative to its parent container, when the object is not in static position in the container. Type a numeric value to change the coordinate.
Data type: Float |
Y | Page Report, Web Report, Library Component | Specifies the vertical coordinate of the object's top left corner, relative to its parent container, when the object is not in static position in the container. Type a numeric value to change the coordinate.
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 in the Pick a Color dialog box. You can also type a hexadecimal RGB or RGBA value (for example, 0x00ff11 or 0xff00ff11) to specify 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 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 | ||
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:
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 preceding 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:
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, measured in cells. Data type: Integer This property takes effect when you set the page report tab or web report's Columned property to "true" and the object's Position property is not "static". |
Row Index | Page Report, Web Report | Specifies the Y coordinate of the object relative to its parent container in the Excel and CSV outputs, measured in cells. Data type: Integer This property takes effect when you set the page report tab or web report's Columned property to "true" and the object's Position property is not "static". |
Padding | ||
Bottom Padding | Page Report, Web Report, Library Component | Specifies 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 Padding | Page Report, Web Report, Library Component | Specifies 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 Padding | Page Report, Web Report, Library Component | Specifies 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 Padding | Page Report, Web Report, Library Component | Specifies 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 Color | Page Report, Web Report, Library Component | Specifies 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 Thickness | Page Report, Web Report, Library Component | Specifies the width for the border of the object. Type a numeric value to change the thickness.
Data type: Float |
Bottom Line | Page Report, Web Report, Library Component | Specifies the line style for the bottom border of the object. Choose an option from the drop-down list.
Data type: Enumeration |
Left Line | Page Report, Web Report, Library Component | Specifies the line style for the left border of the object. Choose an option from the drop-down list.
Data type: Enumeration |
Right Line | Page Report, Web Report, Library Component | Specifies the line style for the right border of the object. Choose an option from the drop-down list.
Data type: Enumeration |
Shadow | Page Report, Web Report, Library Component | Specifies whether to add a drop shadow effect to the border.
Data type: Boolean |
Shadow Color | Page Report, Web Report, Library Component | Specifies 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 Line | Page Report, Web Report, Library Component | Specifies the line style for the top border of the object. Choose an option 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. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify 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: String |
Text Format | ||
Auto Fit | Page Report, Web Report, Library Component | Specifies whether to automatically adjust the width and height of the object according to its content.
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:
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 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
|
Font Face | Page Report, Web Report, Library Component | Specifies 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 Component | Specifies the font size of the text in the object. 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. Choose an option from the drop-down list or type the format by yourself.
Data type: String
|
Format Locale | Page Report, Web Report, Library Component | Specifies 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 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 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 HTML output, so they display exactly as what they are. When you set this property to "false", 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 italicize the text in the object. Data type: Boolean |
Maximum Width | Page Report, Web Report, Library Component | Specifies 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 the Auto Fit property. 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 Fit | Page Report, Web Report, Library Component | Specifies whether to reduce the width of the object according to its content when you specify to automatically adjust its width (set the object's Auto Fit property to "true") and the actual width of the content is smaller than that of the object. Data type: Boolean This property takes effect when you set the object's Position property to "absolute"; but, it does not work if you set the Word Wrap property of the object to "true". |
Strikethrough | Page Report, Web Report, Library Component | Specifies whether to draw a line through the text in the object.
Data type: Boolean |
Underline | Page Report, Web Report, Library Component | Specifies whether to add a horizontal line under the text in the object. 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 according to the width of the object.
Data type: Boolean |
Others | ||
Data Mapping File | Page Report, Web Report, Library Component | Specifies the data mapping file (without the locale part) you want to apply to the object for NLS use.
For example, if the data mapping file is Product_de_DE.properties, type Product in the value cell. Data type: String |
Detail Report | Query Page Report | Specifies the detail report that you want to link the object to. Select the ellipsis in the value cell to set the detail report. See Linking to a Detail Report.
Data type: String |
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 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.
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. 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. 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. Data type: Boolean |
Export to CSV | Page Report, Web Report, Library Component | Specifies whether to include the object in the CSV output.
Data type: Boolean 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, 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 Excel | Page Report, Web Report, Library Component | Specifies whether to include the object in the Excel output.
Data type: Boolean 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, Report Engine only includes the string value in the output. |
Export to HTML | Page Report, Web Report, Library Component | Specifies whether to include the object in the HTML output.
Data type: Boolean |
Export to PDF | Page Report, Web Report, Library Component | Specifies whether to include the object in the PDF output.
Data type: Boolean 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, Report Engine only includes the string value in the output. |
Export to PostScript | Page Report, Web Report, Library Component | Specifies whether to include the object in the PostScript output.
Data type: Boolean 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, Report Engine only includes the string value in the output. |
Export to Report Result | Page Report, Web Report, Library Component | Specifies 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 Component | Specifies whether to include the object in the RTF output.
Data type: Boolean 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, Report Engine only includes the string value in the output; if it displays as a radio button or button, only the text. |
Export to Text | Page Report, Web Report, Library Component | Specifies whether to include the object in the Text output.
Data type: Boolean 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, 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 XML | Page Report, Web Report, Library Component | Specifies whether to include the object in the XML output.
Data type: Boolean 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, 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 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. See Obtaining the Group Details in a Banded Object.
Data type: Boolean |
Invisible | Page Report, Web Report, Library Component | Specifies whether to hide the object in the design area and in the report. Report Engine performs all calculations that involve the object regardless of whether the object is visible or not. Data type: Boolean |
Link | Page Report, Web Report, Library Component | Specifies 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 in the value cell to set the link target. 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 that holds the object is hidden. Choose an option from the drop-down list.
Data type: Enumeration
|
Parameter | Page Report, Web Report, Library Component | Designer 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 |
Position | Page Report, Web Report, Library Component | Designer 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 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.
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 suppress the object in the design area and in the report. If you suppress an object, Report Engine skips all formulas and calculations that involve the object. This property has higher priority over Invisible. Data type: Boolean Web Report Studio does not support this property on the object so it is ignored at runtime. |
Suppress When No Records | Page Report, Web Report, Library Component | Specifies whether to suppress the object in the report when no record is returned to its parent data component.
Data type: Boolean Web Report Studio does not support this property on the object so it is ignored at runtime. |
Suppress When Null | Page Report, Web Report, Library Component | Specifies whether to suppress the field in the report when its value is null. Data type: Boolean |
Transfer Style | Page Report, Web Report, Library Component | Specifies 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 Delimiter | Page Report, Web Report, Library Component | Specifies 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 |
Ignore When No Attachment | Page Report, Web Report, Library Component | Specifies whether to ignore the PDF attachment of the object when it cannot be found. When this property is "false" and Designer cannot load the file during exporting the report to a PDF/A compliant document, the export process will fail. Data type: Boolean |
PDF Attachment | Page Report, Web Report, Library Component | Specifies the file you want to add as attachment of the object in the PDF/A compliant output of the report. Data type: String |
PDF Attachment Name | Page Report, Web Report, Library Component | Specifies the name of the PDF attachment you add to the object. Data type: String |
TOC (available when the parameter field is in a banded object) | ||
Anchor Display Value | Query Page Report | Specifies the text you want to display as the object's TOC entry label, when you set the object's TOC Anchor property to "true". Data type: String |
TOC Anchor | Query Page Report | Specifies whether to include the object in the TOC of the report. Data type: Boolean |
Accessibility | ||
External AccessKey | Query Page Report | This property is mapped to the HTML attribute accesskey, as specified by w3.org. Data type: String |
External CSS Class Selector | Query Page Report | Specifies the name of the Class Selector for the object in the HTML output. Data type: String |
External Dir | Query Page Report | This property is mapped to the HTML attribute dir, as specified by w3.org. Data type: String |
External ID | Query Page Report | This property is mapped to the HTML attribute id, as specified by w3.org. Data type: String |
External Style | Query Page Report | This property is mapped to the HTML attribute style, as specified by w3.org. Data type: String |
External TabIndex | Query Page Report | This property is mapped to the HTML attribute tabindex, as specified by w3.org. Data type: Integer |
HrefLang | Query Page Report | This 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 |
Language | Query Page Report | This property is mapped to the HTML attribute lang, as specified by w3.org. 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. 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.
Data type: Enumeration |
Comments
0 comments
Please sign in to leave a comment.