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 Shows the class type of the object. Read only.
Instance Name Shows the instance name of the object. 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 object's top left corner, relative to its parent container, when the object is not in static position in the container. Type a numeric value to change the coordinate.

Data type: Float
Y Specifies the vertical coordinate of the object's top left corner, relative to its parent container, when the object is not in static position in the container. Type a numeric value to change the coordinate.

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 in the Pick a Color dialog box. You can also 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 preceding sample CSS file to the object, type LabelX in the value cell.
  • Choose a style from the drop-down list when you have specified the Style Group property for the page 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.

Data type: Boolean
Export to Excel Specifies whether to include the object in the Excel output.

Data type: Boolean
Export to HTML Specifies whether to include the object in the HTML output.

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

Data type: Boolean
Export to PostScript Specifies whether to include the object in the PostScript output.

Data type: Boolean
Export to Report Result Specifies whether to include the object when you preview the report in the Page Report Result format in Designer, and when users run the report in the same format at runtime.

Data type: Boolean
Export to RTF Specifies whether to include the object in the RTF output.

Data type: Boolean
Export to Text Specifies whether to include the object in the Text output.

Data type: Boolean
Export to XML Specifies whether to include the object in the XML output.

Data type: Boolean
Invisible Specifies whether to hide the object in the design area and in the report. Logi Report Engine performs all calculations that involve the object regardless of whether the object is visible or not.

Data type: Boolean
Position Designer enables this property when the object is in a flow layout container, such as the report body or a tabular cell, text box, or KPI. You can use it to specify the position of the object in the container. 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 values of the properties in the default location where the object is placed.
  • page header
    Select to calculate values of the properties in the banded page header panel.
  • page footer
    Select to calculate values of the properties in the banded page footer panel.

See Example 2: Showing a Label on Every Page Except the Last.

Data type: Enumeration

Suppress Specifies whether to suppress the object in the design area and in the report. If you suppress an object, Logi Report Engine skips all formulas and calculations that involve the object. This property has higher priority over Invisible.

Data type: Boolean
Suppress When No Records Specifies whether to suppress the object in the report when no record is returned to its parent data component.

Data type: Boolean
Vertical Alignment Specifies the vertical justification of the content in the object. Choose an option from the drop-down list.

Data type: Enumeration
Vertical Auto Size Specifies whether to automatically expand the height of the object according to the size of its content.

Data type: Boolean

Excel
Column Index Specifies the X coordinate of the object relative to its parent container in the Excel and CSV outputs, measured in cells.

Data type: Integer

Note icon This property takes effect when you set the page report tab's Columned property to "true" and the object's Position property is not "static".

Row Index Specifies the Y coordinate of the object relative to its parent container in the Excel and CSV outputs, measured in cells.

Data type: Integer

Note icon This property takes effect when you set the page report tab's Columned property to "true" and the object's Position property is not "static".

Border
Border Color Specifies the color for the border of the object. Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String
Border Thickness Specifies the width for the border of the object. Type a numeric value to change the thickness.

Data type: Float
Bottom Line Specifies the line style for the bottom border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Left Line Specifies the line style for the left border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Right Line Specifies the line style for the right border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Top Line Specifies the line style for the top border of the object. Choose an option from the drop-down list.

Data type: Enumeration
TOC
Anchor Display Value Specifies the text you want to display as the object's TOC entry label, when you set the object's TOC Anchor property to "true".

Data type: String
TOC Anchor Specifies whether to include the object in the TOC of the report.

Data type: Boolean
Accessibility
External CSS Class Selector Specifies the name of the Class Selector for the object in the HTML output.

Data type: String

Back to top

BackPrevious Topic  Next TopicNext