BackPrevious Topic  Next TopicNext

Text Box Properties

This topic describes the properties of a Text Box object that you can use in query-based page reports only.

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 the name of the Class Selector to apply to the object, which you define in the CSS file of the style the report applies.

For example, if you define the CSS file as follows:

@charset "GBK";
TextField {Background: #ff0000}
/*Style=LabelX*/
TextField[Style="LabelX"]{Background: #0000FF}
/*ID=W*/
TextField#W{Background: #FFFF00}
/*class=C*/
TextField.C{Background: #00FFFF}

To apply the Class Selector in the file to the object, type C in the value cell.

Data type: String
Style Specifies the style you want to apply to the object. You can specify the style in two ways:
  • Type the style which should be an Attribute Selector whose attribute is "style" in the CSS file of the style the report applies. For example, to apply the style in the above sample CSS file to the object, type LabelX in the value cell.
  • Choose a style from the drop-down list if you have specified the Style Group property for the report tab, and there are styles in the style group that are applicable to the object.

Data type: String
Others
Auto Scale in Number Specifies whether to automatically scale the Number values in the object that fall into the two ranges:
  • When 1000 <= value < 10^15, Designer applies the following quantity unit symbols of the International System of Units 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, Designer uses scientific notation to scale the values.

Data type: Boolean
Export to CSV Specifies whether to include the object in the CSV output of the report.

Data type: Boolean

Export to Excel Specifies whether to include the object in the Excel output of the report.

Data type: Boolean

Export to HTML Specifies whether to include the object in the HTML output of the report.

Data type: Boolean
Export to PDF Specifies whether to include the object in the PDF output of the report.

Data type: Boolean
Export to PostScript Specifies whether to include the object in the PostScript output 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 output of the report.

Data type: Boolean

Export to Text Specifies whether to include the object in the Text output of the report.

Data type: Boolean
Export to XML Specifies whether to include the object in the XML output 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 that are controlled by formulas. This property takes effect only when the object is in a banded object. Choose an option from the drop-down list.
  • default - Select to calculate the values of the properties in the default location where the object is placed.
  • page header - Select to calculate the values of the properties in the banded page header panel.
  • page footer - Select to calculate the values of the properties in the banded page footer panel.

For more information, see Example 2: Showing a Label on Every Page Except the Last.

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 icon When you set both the Invisible and Suppress properties of an object 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 in the Excel and CSV outputs of the report, measured in cells. This property takes effect only when the Columned property of the report tab is "true" and Position of the object is not "static".

Data type: Integer
Row Index Specifies the Y coordinate of the object relative to its parent container in the Excel and CSV outputs of the report, measured in cells. This property takes effect only when the Columned property of the report tab is "true" and Position of the object is not "static".

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

Back to top

BackPrevious Topic  Next TopicNext