Box Properties

This topic lists the properties of a Box object, which is supported in page reports only.

Property Name	Description
General (only supported on boxes in page reports created using query resources)
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
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 the 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 the 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 the 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 the 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. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
CSS
Class	Specifies a CSS class to be applied to the object which is a valid class in the CSS file. Data type: String
Style	The property can be used in two ways. Specifies a style to be applied to the object. Choose a style from the drop-down list which is available when a Style Group has been selected at the report tab level and when there are styles in the Style Group that can be applied to the object, or type in the style name. Specifies a CSS selector to be applied to the object. Type a valid class name from the CSS file. Data type: String
Others
Export to Excel	Specifies whether to include the object in the Excel result of the report. Data type: Boolean
Export to HTML	Specifies whether to include the object in the HTML result of the report. Data type: Boolean
Export to PDF	Specifies whether to include the object in the PDF result of the report. Data type: Boolean
Export to PostScript	Specifies whether to include the object in the PostScript result 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 result of the report. Data type: Boolean
Export to XML	Specifies whether to include the object in the XML result 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. Data type: Boolean
Record Location	Specifies the calculation point for the properties of the object which are controlled by formulas. Choose an option from the drop-down list. Default - The values of the properties are calculated in the default location where they are located. Page Header - The values of the properties are calculated in the page header. Page Footer - The values of the properties are calculated in the page footer. Data type: Enumeration
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
Excel
Bottom Attach Column	Specifies the X coordinate of the lower right corner of the drawing object in the exported Excel file, measured in cells. Data type: Float
Bottom Attach Row	Specifies the Y coordinate of the lower right corner of the drawing object in the exported Excel file, measured in cells. Data type: Float
Top Attach Column	Specifies the X coordinate of the upper left corner of the drawing object in the exported Excel file, measured in cells. Data type: Float
Top Attach Row	Specifies the Y coordinate of the upper left corner of the drawing object in the exported Excel file, measured in cells. Data type: Float
Box Property
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 type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Border Style	Specifies the line style of the box border. Choose an option from the drop-down list. Data type: Enumeration
Border Thickness	Specifies the width of the object's border. Type a numeric value to change the thickness. Data type: Float
Accessibility (only supported on boxes in page reports created using query resources)
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
External ID	It is mapped to the HTML attribute id. This attribute specifies a name to the object, which must be unique in the report. Data type: String
External Style	It is mapped to the HTML attribute style. This attribute specifies style information for the object. Data type: String
External Title	It is mapped to the HTML attribute title. This attribute offers advisory information about the object. Data type: String
Language	It is mapped to the HTML attribute lang. This attribute specifies the base language of the object's attribute values and text content. Data type: String

Bottom Attach Column, Bottom Attach Row, Top Attach Column, Top Attach Row

The four properties work together to control the position of a drawing object in the exported Excel file. They take effect when the Columned property at the report tab level is set to true.

The first pair of the properties (Top Attach Column, Top Attach Row) locates a cell and uses its upper left corner as the upper left corner of the drawing object, while the second pair (Bottom Attach Column, Bottom Attach Row) locates another cell and uses its upper left corner as the lower right corner of the drawing object.

For example, if the properties for an oval are set as:

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

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

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

Previous Topic Next Topic