Properties of Special Field in Web Report
The properties of a special field object in a web report are as follows:
Property Name | Description |
---|---|
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 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 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 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 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 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 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 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 |
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 |
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.
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 |
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 |
Position | Specifies the position of the object. Choose an option from the drop-down list.
Data type: Enumeration |
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:
|
Record Location | Specifies the calculation point for the properties which use formulas. Choose an option from the drop-down list.
Data type: Enumeration |
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.
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 | 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 | 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 |