Text Box Properties

This topic lists the properties of a Text Box object, which is supported only in page reports created using query resources.

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. Type a numeric value to change the height. Data type: Float
Width	Specifies the width of the object. Type 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. Type 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. Type 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 type 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
Style	The property can be used in two ways. Specifies a style to be applied to the object. Choose a style from the drop-down list which is available when a Style Group has been selected at the report tab level and when there are styles in the Style Group that can be applied to the object, or type in the style name. Specifies a CSS selector to be applied to the object. Type a valid class name from the CSS file. Data type: String
Others
Auto Scale in Number	Specifies whether to automatically scale the values that are of the Number data type in the object when the values 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. Data type: Boolean
Export to CSV	Specifies whether to include the object in the CSV result of the report. Data type: Boolean
Export to Excel	Specifies whether to include the object in the Excel result of the report. Data type: Boolean
Export to HTML	Specifies whether to include the object in the HTML result of the report. Data type: Boolean
Export to PDF	Specifies whether to include the object in the PDF result of the report. Data type: Boolean
Export to PostScript	Specifies whether to include the object in the PostScript result of the report. Data type: Boolean
Export to Report Result	Specifies whether to include the object when previewing the report in Page Report Result and running the report in Page Report Studio. Data type: Boolean
Export to RTF	Specifies whether to include the object in the RTF result of the report. Data type: Boolean
Export to Text	Specifies whether to include the object in the Text result of the report. Data type: Boolean
Export to XML	Specifies whether to include the object in the XML result of the report. Data type: Boolean
Invisible	Specifies whether to show the object in the design area and in the report result. All formulas and calculations will still be performed if the property is set to true. Data type: Boolean
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 of the object which are controlled by formulas. Choose an option from the drop-down list. Default - The values of the properties are calculated in the default location where they are located. Page Header - The values of the properties are calculated in the page header. Page Footer - The values of the properties are calculated in the page footer. Data type: Enumeration
Suppress	Specifies whether to show the object in the design area and in the report result. 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 result when no record is returned to its parent data component. 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
Vertical Auto Size	If true, the height of the object will be automatically adjusted according to the size of the contents. Data type: Boolean
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
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 type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Border Thickness	Specifies the width of the border. Type 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
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 CSS Class Selector	Specifies a class selector to be applied to the object when exported as HTML. Type a valid class name from the CSS file. Data type: String

Previous Topic Next Topic