Previous Page Next Page
The Special Field object is supported in page reports, web reports and library components. It contains the following properties and the availabilities of the properties vary for the report types.
| Property Name | Available For | Description |
|---|---|---|
| General | ||
| Class Type | Query Page Report | Indicates the class type of the object. This property is read only. |
| Instance Name | Query Page Report | Shows the instance name of the object. This property is read only. |
| Geometry | ||
| Height | Page Report, Web Report, Library Component | Specifies the height of the object. Enter a numeric value to change the height.
Data type: Float |
| Width | Page Report, Web Report, Library Component | Specifies the width of the object. Enter a numeric value to change the width.
Data type: Float |
| X | Page Report, Web Report, Library Component | Specifies the horizontal coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position.
Data type: Float |
| Y | Page Report, Web Report, Library Component | Specifies the vertical coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position.
Data type: Float |
| Color | ||
| Background | Page Report, Web Report, Library Component | Specifies the background color of the object. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Foreground | Page Report, Web Report, Library Component | Specifies the foreground color of the object. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| CSS | ||
| Class | Page Report, Web Report, Library Component | Specifies a CSS class to be applied to the object which is a valid class in the CSS file.
Data type: String |
| ID | Page Report, Web Report, Library Component | Specifies the identifier of the object, which must be unique in the report. The ID property can be a style sheet selector.
Data type: String |
| Style | Page Report, Web Report, Library Component | The property can be used in two ways.
Data type: String |
| Excel | ||
| Column Index | Page Report, Web Report | Specifies the X coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the page report tab or web report level must be set to true for this property to take effect.
Data type: Integer |
| Row Index | Page Report, Web Report | Specifies the Y coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the page report tab or web report level must be set to true for this property to take effect.
Data type: Integer |
| Padding | ||
| Bottom Padding | Page Report, Web Report, Library Component | Specifies the space between the text and the bottom border of the object. Enter 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. Enter 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. Enter 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. Enter 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 enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Border Thickness | Page Report, Web Report, Library Component | Specifies the width of the border. Enter a numeric value to change the thickness.
Data type: Float |
| Bottom Line | 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 enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Top Line | Page Report, Web Report, Library Component | Specifies the line style of the top border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
| Pattern | ||
| Pattern Color | Page Report, Web Report, Library Component | Specifies the color in which to draw a pattern to fill the object. Choose a color from the drop-down list or select Custom to customize a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. For page report, you can also use a formula or edit an expression that returns a color.
Data type: String |
| Pattern Style | Page Report, Web Report, Library Component | Specifies the style of the pattern. Choose an option from the drop-down list.
Data type: Enumeration |
| Text Format | ||
| Auto 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 |
| Bold | Page Report, Web Report, Library Component | Specifies whether to make the text bold.
Data type: Boolean |
| Font Face | Page Report, Web Report, Library Component | Specifies the font of the text. Choose an option from the drop-down list.
Data type: Enumeration |
| Font Size | Page Report, Web Report, Library Component | Specifies the font size of the text. Enter an integer value to change the size.
Data type: Integer |
| Format | Page Report, Web Report, Library Component | Specifies the display format of the text in the report result. It varies with data type and can be manually defined.
Data type: String Note: For the BigDecimal type, to avoid precision loss, you should enter a prefix JRD when setting the format property value. |
| 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 tags in the HTML result of the report.
This property is useful for exporting a report to HTML format. You may want to write the label contents in HTML tags in your report, and in the HTML result files, the tags will be transferred as they are translated into HTML. 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. Enter 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 Evaluation Setting | Page Report, Web Report, Library Component | Specifies the group information for the object. Available only for the group-by fields in table group columns. Choose an option from the drop-down list.
Data type: Enumeration |
| 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. Click  in the value cell to set the detail report. For details, refer to Linking to a Detail Report.
Data type: String |
| 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 special 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 | Query Page Report | 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 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 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 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 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 checkbox, radio button or button.
Data type: Boolean |
| Field Type | Page Report, Web Report, Library Component | Specifies another special field format to substitute the current special field. Choose an option from the drop-down list.
Data type: Enumeration |
| Go to Detail | Query Page Report | Specifies whether to show the detailed information when you click 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 results. 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. Click in the value cell to set the link target. For details, see Binding a Link to a Label.
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:
|
| 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 which use formulas. Choose an option from the drop-down list.
Data type: Enumeration |
| Repeat | Page Report, Web Report, Library Component | Specifies whether to repeat the group name in the report results. This property is available only for the group-by fields in table, and it takes effect only when the group-by fields are in the table detail row.
Data type: Boolean |
| Suppress | Page Report, Web Report, Library Component | Specifies whether to show the object in the design area and in the report results. 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 results when no record is returned to its parent data component. Not supported in Web Report Studio.
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 |
| TOC (supported on special fields 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. Enter 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:
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. Enter an integer equal to or greater than 0 and less than 65535.
Data type: Integer |
| External Title | Query Page Report | It is mapped to the HTML attribute title. This attribute offers advisory information about the object.
Data type: String |
| 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 |
| LongDesc | Query Page Report | It is mapped to the HTML attribute longdesc. This attribute specifies a link to a long description of the object.
Data type: String |