Skip to main content

UDO Properties

  • Updated

BackPrevious Topic  Next TopicNext

UDO Properties

This topic describes the properties of a UDO (user-defined object) that you can use in query-based page reports only.

A UDO has special properties defined by users. The properties listed in the Report Inspector correspond with the ones defined in your UDO programs. The following shows the default properties.

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

ForegroundSpecifies the foreground 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
Export to CSVSpecifies whether to include the object in the CSV output. If it is set to true, only the text value will be included.

Data type: Boolean

Export to ExcelSpecifies whether to include the object in the Excel output. If it is set to true, only the text value will be included.

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. If it is set to true, only the text value will be included.

Data type: Boolean

Export to XMLSpecifies whether to include the object in the XML output. If it is set to true, only the text value will be included.

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

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

Column NumberSpecifies the number of columns to determine the width of the object in the Excel and CSV outputs. This property takes effect when you set Columned of the page report tab to "true". Type an integer value to change the number.

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

Row NumberSpecifies the number of rows to determine the height of the object in the Excel and CSV outputs. This property takes effect when you set Columned of the page report tab to "true". Type an integer value to change the number.

Data type: Integer

Font
BoldSpecifies whether to make the text bold.

Data type: Boolean

Font Face Specifies the font of the text. Choose an option from the drop-down list.

Data type: Enumeration

Font Size Specifies the font size of the text. Type an integer value to change the size.

Data type: Integer

ItalicSpecifies whether to make the text italic.

Data type: Boolean

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

Data type: String

Note iconLogi Report UDO does not support RTF and PDF outputs. That is, when exporting to RTF and PDF, a report with a UDO may not be rendered correctly. However, there is no such problem for HTML and PostScript.

Properties of the Built-in UDOs

Logi Report provides you with two built-in UDOs: JHyperLink and JRotator. Each of them has some unique properties.

Properties of JHyperLink

JHyperLink operates in a similar way to the hyperlink in an HTML file (only for Windows NT). The following table lists its special properties.

Property NameDescription
Others
Auto FitSpecifies whether to adjust the width and height of the object according to the contents.

Data type: Boolean

Display Value Specifies the displayed text of the hyperlink. This property has lower priority than Display Image.

Data type: String

Enable Hyperlink in Excel Specifies whether to enable the hyperlink in the Excel output.

Data type: Boolean

Enable Hyperlink in HTML Specifies whether to enable the hyperlink in the HTML output.

Data type: Boolean

Enable Hyperlink in PDF Specifies whether to enable the hyperlink in the PDF output.

Data type: Boolean

Executer Class NameIf the specified URL is linked to a .rst file - the result file for the Logi Report Result export format, you should select jet.udos.RPTExecuter. For other links, use jet.udos.IEExecuter.

Data type: String

Horizontal Alignment Specifies the horizontal justification of the content in the JHyperLink container. Choose an option from the drop-down list.

Data type: Enumeration

HTML StyleSpecifies the CSS style of the JHyperLink in HTML output and in Page Report Studio. The value is a String value containing only the body part of a CSS style definition. Make sure that you provide the right CSS style string.

For Example, if a full style definition is:

style="text-decoration:underline;color:#ffc800;font:italic small-caps bold 12pt serif;"

you need only type the content in the quotation marks as the HTML Style value:

text-decoration:underline;color:#ffc800;font:italic small-caps bold 12pt serif;

Data type: String

TargetSpecifies the window or frame at which to target contents. Choose an option from the drop-down list.
  • blank - Loads the linked document into a new blank window. This window is not named.
  • self - Loads the linked document into the window in which the link is selected (the active window).
  • parent - Loads the linked document into the immediate parent window of the active window. If there is no parent window, the active window is used.
  • top - Loads the linked document into the topmost window.

Data type: Enumeration

Tooltips TextSpecifies the tool tip that displays when you hover over the JHyperLink in Designer view mode, in HTML output, or in Page Report Studio.

Data type: String

URLSpecifies the URL for accessing the linked file or website page.

Data type: String

Vertical Alignment Specifies the vertical justification of the content in the JHyperLink container. Choose an option from the drop-down list.

Data type: Enumeration

Word WrapSpecifies whether to enable the word wrap function of JHyperLink in the exported files.

Data type: Boolean

Image
Alternate TextSpecifies the text you want to show instead when the image cannot display.

Data type: String

Display ImageSpecifies the local path of the image displayed for the hyperlink (like a hotspot in HTML). This property has higher priority than Display Value.

Data type: String

OriginalSpecifies from where the image is fetched when viewing or running the report on Server.

This property has following two options:

  • true - If selected, the image will not be delivered when publishing the report to Server. Server will find the image from the local directory specified by the property Display Image when you view the report.
  • false - If selected, the image will be delivered when publishing the report to Server. Server will obtain the image from the Server side when you view or run the report.

Data type: Boolean

Accessibility
External AccessKeyIt is mapped to the HTML attribute accesskey. This attribute specifies an access key to the object.

Data type: String

External CSS Class SelectorSpecifies 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

HrefLangIt is mapped to the HTML attribute hreflang. This attribute specifies the base language of the resource designated by a link and may only be used when a link is specified.

Data type: String

The following shows an example about using the JHyperLink properties.

  1. Insert two JHyperLink UDOs in a page report.
  2. Set the properties of one UDO as follows:
    • URL: http://www.logianalytics.com
    • Display Value: go here.
  3. Specify the properties of the other UDO to the following:
    • URL: C:\docword.txt
    • Display Value: abc
    • Display Image: C:\LogiReport\Designer\Demo\SampleReports\Coffee.jpg

At runtime, when users point to either UDO, a hand shows that it is a hyperlink. By selecting it, they will be taken to the destination. The application launched to open it (the linked file) is from the user's Windows NT system. If you specify both Display Value and Display Image, the image has the higher priority to display.

Properties of JRotator

JRotator is a built-in UDO that can be rotated. You can put text and images in a JRotator. The following table lists its special properties.

Property NameDescription
Others
Display ImageSpecifies the local path of the image displayed in the JRotator. This property has higher priority than Display Value.

Data type: String

Display ValueSpecifies the text displayed in the JRotator. This property has lower priority than Display Image.

Data type: String

Horizontal Alignment Specifies the horizontal justification of the text in the JRotator container. Choose an option from the drop-down list.

Data type: Enumeration

RotateSpecifies the angle at which to rotate the JRotator, in degrees.
  • 0 - No rotation.
  • positive value - Rotates the JRotator clockwise.
  • negative value - Rotates the JRotator anticlockwise.

Data type: Integer

Vertical Alignment Specifies the vertical justification of the text in the JRotator container. Choose an option from the drop-down list.

Data type: Enumeration

BackPrevious Topic  Next TopicNext