Skip to main content

Box Properties

  • Updated

BackPrevious Topic  Next TopicNext

Box Properties

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

Property NameDescription
General (available when the object is in a query-based page report)
Class TypeShows the class type of the object. Read only.
Instance NameShows the instance name of the object. Read only.
Geometry
Bottom Attach Pos XSpecifies the horizontal coordinate for the bottom right point of the box in the involved banded panel.

Data type: Float

Bottom Attach Pos YSpecifies the vertical coordinate for the bottom right point of the box in the involved banded panel.

Data type: Float

Top Attach Pos XSpecifies the horizontal coordinate for the top left point of the box in the involved banded panel.

Data type: Float

Top Attach Pos YSpecifies the vertical coordinate for the top left point of the box in the involved banded panel.

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 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
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 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
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 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

Record LocationSpecifies the calculation point for the properties of the object that are controlled by formulas. 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 When No RecordsSpecifies whether to suppress the object in the report when no record is returned to its parent data component.

Data type: Boolean

Excel
Bottom Attach ColumnSpecifies the X coordinate for the lower right corner of the object in the Excel output, measured in cells.

Data type: Float

Note icon This property takes effect when you set the page report tab's Columned property to "true".

Bottom Attach RowSpecifies the Y coordinate for the lower right corner of the object in the Excel output, measured in cells.

Data type: Float

Note icon This property takes effect when you set the page report tab's Columned property to "true".

Top Attach ColumnSpecifies the X coordinate for the upper left corner of the object in the Excel output, measured in cells.

Data type: Float

Note icon This property takes effect when you set the page report tab's Columned property to "true".

Top Attach RowSpecifies the Y coordinate for the upper left corner of the object in the Excel output, measured in cells.

Data type: Float

Note icon This property takes effect when you set the page report tab's Columned property to "true".

Box Property
Border ColorSpecifies 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 StyleSpecifies the line style for the border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Border ThicknessSpecifies the width for the border of the object. Type a numeric value to change the thickness.

Data type: Float

Accessibility(available when the object is in a query-based page report)
External CSS Class SelectorSpecifies the name of the Class Selector for the object in the HTML output.

Data type: String

External IDThis property is mapped to the HTML attribute id, as specified by w3.org.

Data type: String

External StyleThis property is mapped to the HTML attribute style, as specified by w3.org.

Data type: String

External TitleThis property is mapped to the HTML attribute style, as specified by w3.org.

Data type: String

LanguageThis property is mapped to the HTML attribute lang, as specified by w3.org.

Data type: String

Excel

The four properties, Bottom Attach Column, Bottom Attach Row, Top Attach Column, and Top Attach Row work together to control the position of a drawing object when you export a report to a columned file such as Excel and CSV.

You can set Top Attach Column and Top Attach Row to locate a cell and use its upper left corner as the upper left corner of the drawing object, and set Bottom Attach Column and Bottom Attach Row to locate another cell and use its upper left corner as the lower right corner of the drawing object.

For example, if you set the properties for a drawing object as:

Top Attach Column: 1, Top Attach Row: 2, Bottom Attach Column: 3, Bottom Attach Row: 4

Then, the upper left cell is A2 and the lower right cell is C4.

Note icon The value you set for the Top Attach Column (Top Attach Row) property should be always larger than that for Bottom Attach Column (Bottom Attach Row).

BackPrevious Topic  Next TopicNext