Skip to main content

Text Box Properties

  • Updated

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 NameDescription
General
Class TypeIndicates 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
HeightSpecifies the height of the object. Type a numeric value to change the height.

Data type: Float

WidthSpecifies the width of the object. Type a numeric value to change the width.

Data type: Float

XSpecifies the horizontal coordinate of the object's top left corner, relative to its parent container, which Logi Report Engine applies when the object is not in static position in the container. Type a numeric value to change the coordinate.

Data type: Float

YSpecifies the vertical coordinate of the object's top left corner, relative to its parent container, which Logi Report Engine applies when the object is not in static position in the container. Type a numeric value to change the coordinate.

Data type: Float

Color
BackgroundSpecifies 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
ClassSpecifies 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

StyleSpecifies 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 if 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 NumberSpecifies whether to automatically scale the Number values in the object that fall into the two ranges:
  • When 1000 <= value < 10^15, Logi Report Engine 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, Logi Report Engine uses scientific notation to scale the values.

Data type: Boolean

Export to CSVSpecifies whether to include the object in the CSV output.

Data type: Boolean

Export to ExcelSpecifies whether to include the object in the Excel output.

Data type: Boolean

Export to HTMLSpecifies whether to include the object in the HTML output.

Data type: Boolean

Export to PDFSpecifies whether to include the object in the PDF output.

Data type: Boolean

Export to PostScriptSpecifies whether to include the object in the PostScript output.

Data type: Boolean

Export to Report ResultSpecifies 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 RTFSpecifies whether to include the object in the RTF output.

Data type: Boolean

Export to TextSpecifies whether to include the object in the Text output.

Data type: Boolean

Export to XMLSpecifies whether to include the object in the XML output.

Data type: Boolean

InvisibleSpecifies 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

PositionDesigner 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 LocationSpecifies 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.

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

Data type: Enumeration

SuppressSpecifies 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 RecordsSpecifies whether to display the object in the report when no record is returned to its parent data component.

Data type: Boolean

Vertical AlignmentSpecifies the vertical justification of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration

Vertical Auto SizeIf true, the height of the object will be automatically adjusted according to the size of the contents.

Data type: Boolean

Excel
Column IndexSpecifies the X coordinate of the object relative to its parent container in the Excel and CSV outputs, measured in cells. This property takes effect when you set Columned of the page report tab to "true" and Position of the object is not "static".

Data type: Integer

Row IndexSpecifies the Y coordinate of the object relative to its parent container in the Excel and CSV outputs, measured in cells. This property takes effect when you set Columned of the page report tab to "true" and Position of the object is not "static".

Data type: Integer

Border
Border ColorSpecifies 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 ThicknessSpecifies the width of the border. Type a numeric value to change the thickness.

Data type: Float

Bottom LineSpecifies the line style of the bottom border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Left LineSpecifies the line style of the left border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Right LineSpecifies the line style of the right border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Top LineSpecifies the line style of the top border of the object. Choose a style from the drop-down list.

Data type: Enumeration

TOC
Anchor Display ValueSpecifies the text you want to display as the object's TOC entry label. This property takes effect when you set TOC Anchor of the object to "true".

Data type: String

TOC AnchorSpecifies whether to include the object in the TOC of the report.

Data type: Boolean

Accessibility
External CSS Class SelectorSpecifies the name of the Class Selector for the object in the HTML output.

Data type: String

BackPrevious Topic  Next TopicNext