Skip to main content

OLE Object Properties

  • Updated

BackPrevious Topic  Next TopicNext

OLE Object Properties

This topic describes the properties of an OLE Object, that is, a multimedia object that you can use in page reports and web reports.

Designer provides some properties only when you use the object in certain report types. You can get details from the Available For column in the property table.

Property NameAvailable ForDescription
General
Class TypeQuery Page ReportShows the class type of the object. This property is read only.
Instance Name Query Page ReportShows the instance name of the object. This property is read only.
Geometry
HeightPage Report, Web ReportSpecifies the height of the object. Type a numeric value to change the height.

Data type: Float

WidthPage Report, Web ReportSpecifies the width of the object. Type a numeric value to change the width.

Data type: Float

XPage Report, Web ReportSpecifies 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

YPage Report, Web ReportSpecifies 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
BackgroundPage Report, Web ReportSpecifies 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
ClassPage Report, Web ReportSpecifies 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

StylePage Report, Web ReportSpecifies 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 report tab or web report, and there are styles in the style group that are applicable to the object.

Data type: String

Others
Export to CSVPage Report, Web ReportSpecifies whether to include the object in the CSV output.

Data type: Boolean

Export to ExcelPage Report, Web ReportSpecifies whether to include the object in the Excel output.

Data type: Boolean

Export to HTMLPage Report, Web ReportSpecifies whether to include the object in the HTML output.

Data type: Boolean

Export to PDFPage Report, Web ReportSpecifies whether to include the object in the PDF output.

Data type: Boolean

Export to PostScriptPage Report, Web ReportSpecifies whether to include the object in the PostScript output.

Data type: Boolean

Export to Report ResultPage Report, Web ReportSpecifies whether to include the object when you preview the report in the Page Report Result format for a page report or Web Report Result for a web report in Designer, and when users run the report in the same format at runtime.

Data type: Boolean

Export to RTFPage Report, Web ReportSpecifies whether to include the object in the RTF output.

Data type: Boolean

Export to TextPage Report, Web ReportSpecifies whether to include the object in the Text output.

Data type: Boolean

Export to XML Page Report, Web ReportSpecifies whether to include the object in the XML output.

Data type: Boolean

InvisiblePage Report, Web ReportSpecifies 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

PositionPage Report, Web ReportDesigner 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 LocationPage Report, Web ReportSpecifies 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

SuppressQuery Page ReportSpecifies 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 RecordsQuery Page ReportSpecifies whether to suppress the object in the report when no record is returned to its parent data component.

Data type: Boolean

Excel
Column IndexPage Report, Web ReportSpecifies 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 or web report to "true" and Position of the object is not "static".

Data type: Integer

Row IndexPage Report, Web ReportSpecifies 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 or web report to "true" and Position of the object is not "static".

Data type: Integer

Border
Border ColorPage Report, Web ReportSpecifies 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 ThicknessPage Report, Web ReportSpecifies the width for the border of the object. Type a numeric value to change the thickness.

Data type: Float

Bottom LinePage Report, Web ReportSpecifies the line style for the bottom border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Left LinePage Report, Web ReportSpecifies the line style for the left border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Right LinePage Report, Web ReportSpecifies the line style for the right border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Top LinePage Report, Web ReportSpecifies the line style for the top border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Object Settings
Access KeyPage Report, Web ReportSpecifies the accelerator key for the object.

Data type: String

Alternate TextPage Report, Web Report

Specifies the text you want to show instead when the object cannot display.

Data type: String

ArchivePage Report, Web ReportSpecifies the character string that can be used to implement your own archive functionality for the object.

Data type: String

Class IDPage Report, Web ReportSpecifies the class identifier of the object.

Data type: String

Code BasePage Report, Web ReportSpecifies the base path used to resolve relative URIs specified by the Class ID and Archive properties. Logi Report Engine applies the base URI of the current report when the property value is null.

Data type: String

DeclarePage Report, Web ReportSpecifies whether to make the current object definition a declaration only. The object must be instantiated by a subsequent object definition referring to this declaration.

Data type: Boolean

Horizontal SpacePage Report, Web ReportSpecifies the horizontal margin for the object.

Data type: Float

NamePage Report, Web ReportSpecifies the name of the object.

Data type: String

Stand ByPage Report, Web ReportSpecifies the message you want to display while the object is being loaded.

Data type: String

Tab IndexPage Report, Web ReportSpecifies the index that defines the tab order for the object.

Data type: Integer

TitlePage Report, Web ReportSpecifies the tool tip information of the object, which displays when you hover over the object in HTML output or at runtime.

Data type: String

Use MapPage Report, Web ReportSpecifies the URL, often with a bookmark extension (#name), to use as a client-side image map.

Data type: String

Value TypePage Report, Web ReportSpecifies the MIME (Multipurpose Internet Mail Extensions) type of the object.

Data type: String

Vertical SpacePage Report, Web ReportSpecifies the vertical margin for the object.

Data type: Float

Accessibility
External CSS Class SelectorQuery Page ReportSpecifies the name of the Class Selector for the object in the HTML output.

Data type: String

BackPrevious Topic  Next TopicNext