Box Properties
This topic describes the properties of a Box object that you can use in page reports only.
Property Name | Description |
---|---|
General (available when the object is in a query-based page report) | |
Class Type | Shows 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 | |
Bottom Attach Pos X | Specifies the horizontal coordinate of the bottom right point of the box in a banded panel. A drawing object can cross panels and the coordinate indicates its relative position in the involved panel. Data type: Float |
Bottom Attach Pos Y | Specifies the vertical coordinate of the bottom right point of the box in a banded panel. A drawing object can cross panels and the coordinate indicates its relative position in the involved panel.
Data type: Float |
Top Attach Pos X | Specifies the horizontal coordinate of the top left point of the box in a banded panel. A drawing object can cross panels and the coordinate indicates its relative position in the involved panel. Data type: Float |
Top Attach Pos Y | Specifies the vertical coordinate of the top left point of the box in a banded panel. A drawing object can cross panels and the coordinate indicates its relative position in the involved panel. 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:
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:
Data type: String |
Others | |
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 you preview the report in Page Report Result in Designer, and when users run the report in Page Report Studio at runtime.
Data type: Boolean |
Export to RTF | Specifies whether to include the object in the RTF 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 hide the object in the design area and in the report result. Logi Report Engine performs all the calculations that involve the object regardless of whether the object is visible or not. Data type: Boolean |
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.
For more information, see Example 2: Showing a Label on Every Page Except the Last. Data type: Enumeration |
Suppress When No Records | Specifies whether to exclude the object in the report result when no record is returned to its parent data component.
Data type: Boolean |
Excel | |
Bottom Attach Column | Specifies the X coordinate of the lower right corner of the drawing object in the Excel and CSV outputs of the report tab, measured in cells. This property takes effect only when Columned of the report tab is "true". Data type: Float |
Bottom Attach Row | Specifies the Y coordinate of the lower right corner of the drawing object in the Excel and CSV outputs of the report tab, measured in cells. This property takes effect only when Columned of the report tab is "true". Data type: Float |
Top Attach Column | Specifies the X coordinate of the upper left corner of the drawing object in the Excel and CSV outputs of the report tab, measured in cells. This property takes effect only when Columned of the report tab is "true". Data type: Float |
Top Attach Row | Specifies the Y coordinate of the upper left corner of the drawing object in the Excel and CSV outputs of the report tab, measured in cells. This property takes effect only when Columned of the report tab is "true". Data type: Float |
Box Property | |
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 Style | Specifies the line style for the border of the object. Choose an option from the drop-down list.
Data type: Enumeration |
Border Thickness | Specifies 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 Selector | Specifies the name of the Class Selector for the object in the HTML output of the report. Data type: String |
External ID | This property is mapped to the HTML attribute id, as specified by w3.org. Data type: String |
External Style | This property is mapped to the HTML attribute style, as specified by w3.org. Data type: String |
External Title | This property is mapped to the HTML attribute style, as specified by w3.org. Data type: String |
Language | This 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.
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).