Special Field

The properties of a special field object are:

Property Name	Description
General
Display Name	Specifies the display name of the object. Data type: String
Instance Name	Shows the instance name of the object. This property is read only.
Geometry
Height	Specifies the height of the object, in inches. Enter a numeric value to change the height. Data type: Float
Width	Specifies the width of the object, in inches. 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 unavailable if the Position property is set to static. Enter a numeric value to change the position in inches. Data type: Float
Y	Specifies the vertical coordinate of the top left corner of the object, relative to its parent container. This property is unavailable if the Position property is set to static. Enter a numeric value to change the position in inches. Data type: Float
Color
Background	Specifies the background color of the object. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog. 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 define a color in the Color Picker dialog. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Text Format
Auto Fit	Specifies whether to adjust the width and height of the object according to the contents. Data type: Boolean
Auto Scale in Number	The property is available when the object is of the Number data type. It specifies whether to automatically scale the object values that fall into the two ranges: When 1000 <= value < 10^15, the following quantity unit symbols of the International System of Units are used 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, scientific notation is used to scale the values. The option "auto" means that the property setting follows that of the object's parent data container. 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 Notes: For the BigDecimal data type, to avoid precision loss, you should enter a prefix JRD when setting the Format property value. For the Number data type and when the Auto Scale in Number property is true, the Format property applies to the integer part of the values after scaled, but if the specified format conflicts with the Auto Scale in Number property, for example, the values are displayed in percentage, then the Auto Scale in Number property is ignored.
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
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
Border
Border Color	Specifies the color of the border of the object. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog. 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 in inches. 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
Top Line	Specifies the line style of the top border of the object. Choose a style from the drop-down list. Data type: Enumeration
Padding
Bottom Padding	Specifies the space between the text and the bottom border of the object, in inches. 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, in inches. 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, in inches. 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, in inches. Enter a numeric value to change the padding. Data type: Float
Others
Display Null	Specifies the string to be displayed if the field value is null. Data type: String
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 in Web Report Studio or when the report is opened in Web 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 or hide the object. All formulas and calculations will still be performed if the property is set to true. For an independent special field, you can also use a formula to control whether or not to show it. Data type: Boolean
Position	Specifies the position of the object. Choose an option from the drop-down list. static - The object is positioned at the location in which it is inserted. If selected, the X, Y and other position-related properties will be hidden or disabled. The position of the object is affected by preceding objects in the same container. absolute - The object will be located at the position specified by dragging and dropping or by setting its X and Y property values. The position of the object is not affected by preceding objects in the same container. Data type: Enumeration Note: This property only affects objects with a parent container that is the report body, a table cell, or a tabular cell.

Previous Topic Next Topic

Special Field

Recently viewed articles