Properties of Special Field in Page Report
The properties of a special field object in a page report are:
Property Name | Description |
---|---|
General | |
Class Type | Indicates the class type of the object. This property is read only. |
Instance Name | Shows the instance name of the object. This property is read only. |
Geometry | |
Height | Specifies the height of the object. Enter a numeric value to change the height.
Data type: Float |
Width | Specifies the width of the object. Enter a numeric value to change the width.
Data type: Float |
X | 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 | 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 | Specifies the background color of the object. Choose a color from the drop-down list or select Custom to customize a color. You can also use a formula or edit an expression that returns a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
Foreground | Specifies the foreground color of the object. Choose a color from the drop-down list or select Custom to customize a color. You can also use a formula or edit an expression that returns a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
CSS | |
Class | Specifies a CSS class to be applied to the object which is a valid class in the CSS file.
Data type: String |
ID | 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 | The property can be used in two ways.
Data type: String |
Excel | |
Column Index | 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 report tab level must be set to true for this property to take effect.
Data type: Integer |
Row Index | 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 report tab level must be set to true for this property to take effect.
Data type: Integer |
Padding | |
Bottom Padding | 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 | 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 | 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 | 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 | Specifies the color of the border of the object. Choose a color from the drop-down list or select Custom to customize a color. You can also use a formula or edit an expression that returns a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
Border Thickness | Specifies the width of the border. Enter a numeric value to change the thickness.
Data type: Float |
Bottom Line | Specifies the line style of the bottom border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
Left Line | Specifies the line style of the left border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
Right Line | Specifies the line style of the right border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
Shadow | Specifies whether to draw two shadowed borders, beneath and to the right of the object.
Data type: Boolean |
Shadow Color | Specifies the color of the shadow. Choose a color from the drop-down list or select Custom to customize a color. You can also use a formula or edit an expression that returns a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
Top Line | 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 | 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. You can also use a formula or edit an expression that returns a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
Pattern Style | Specifies the style of the pattern. Choose an option from the drop-down list.
Data type: Enumeration |
Text Format | |
Auto Fit | Specifies whether to adjust the width and height of the object according to the contents.
Data type: Boolean |
Bold | Specifies whether to make the text bold.
Data type: Boolean |
Font Face | Specifies the font of the text. Choose an option from the drop-down list.
Data type: Enumeration |
Font Size | Specifies the font size of the text. Enter an integer value to change the size.
Data type: Integer |
Format | 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 | Specifies the horizontal justification of the text in the object. Choose an option from the drop-down list.
Data type: Enumeration |
Ignore HTML Tag | Specifies whether or not to ignore the HTML tags when exporting the report results to HTML format.
This property is useful for exporting the report results to HTML format. You may want to write the label contents in HTML tags in your report, and for the exported HTML files, the tags will be transferred as they are translated into HTML. Data type: Boolean |
Italic | Specifies whether to make the text italic.
Data type: Boolean |
Maximum Width | 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 | Specifies whether to add a strikethrough line to the text.
Data type: Boolean |
Underline | Specifies whether to underline the text.
Data type: Boolean |
Vertical Alignment | Specifies the vertical justification of the text in the object. Choose an option from the drop-down list.
Data type: Enumeration |
Word Wrap | Specifies whether to wrap the text to the width.
Data type: Boolean |
Others | |
Data Evaluation Setting | 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 | 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 | 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: String |
Detail Target Frame | Specifies the target window or frame in which to display the detailed information. This property is enabled only when Go To Detail is set to true. Choose an option from the drop-down list.
Data type: String |
Display Null | Specifies the string to be displayed if the field value is null.
Data type: String |
Enable Hyperlink in Excel | Specifies whether to enable the link defined on the object when exporting the report to an Excel file.
Data type: Boolean |
Enable Hyperlink in HTML | Specifies whether to enable the link defined on the object when exporting the report to an HTML file.
Data type: Boolean |
Enable Hyperlink in PDF | Specifies whether to enable the link defined on the object when exporting the report to a PDF file.
Data type: Boolean |
Export to Applet | Specifies whether to include the object when exporting the report to Applet.
Data type: Boolean |
Export to CSV | Specifies whether to include the object when exporting the report to CSV.
Data type: Boolean |
Export to Excel | Specifies whether to include the object when exporting the report to Excel.
Data type: Boolean |
Export to HTML | Specifies whether to include the object when exporting the report to HTML.
Data type: Boolean |
Export to PDF | Specifies whether to include the object when exporting the report to PDF.
This property is available only when the object is displayed as a web control.
Data type: Boolean |
Export to PostScript | Specifies whether to include the object when exporting the report to PostScript.
Data type: Boolean |
Export to Report Result | Specifies whether to include the object when exporting the report to Report Result.
Data type: Boolean |
Export to RTF | Specifies whether to include the object when exporting the report to RTF.
Data type: Boolean |
Export to Text | Specifies whether to include the object when exporting the report to Text.
Data type: Boolean |
Export to XML | Specifies whether to include the object when exporting the report to XML.
Data type: Boolean |
Field Type | 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 | 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 | 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 | 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 Binding a Link to a Label.
Data type: String |
Logic Column | 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. Choose an option from the drop-down list.
Data type: Enumeration Notes:
|
Position | Specifies the position of the object. Choose an option from the drop-down list.
Data type: Enumeration |
Record Location | Specifies the calculation point for the properties which use formulas. Choose an option from the drop-down list.
Data type: Enumeration |
Repeat | 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 | 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.
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 | Specifies whether to display the object in the report results when no record is returned to its parent data component.
Data type: Boolean |
Transfer Style | 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 | |
Anchor Display Value | 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 | Specifies whether to include the object in the TOC Browser for the report.
Data type: Boolean |
Accessibility | |
External AccessKey | It is mapped to the HTML attribute accesskey. This attribute specifies an access key to the object.
Data type: String |
External CSS Class Selector | 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 | 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 | 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 | It is mapped to the HTML attribute style. This attribute specifies style information for the object.
Data type: String |
External TabIndex | 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 | It is mapped to the HTML attribute title. This attribute offers advisory information about the object.
Data type: String |
HrefLang | 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 | 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 | It is mapped to the HTML attribute longdesc. This attribute specifies a link to a long description of the object.
Data type: String |