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 Name Description
General
Class Type Shows the class type of the object. Read only.
Instance Name Shows the instance name of the object. Read only.
Geometry
Height Specifies the height of the object. Type a numeric value to change the height.

Data type: Float

Width Specifies the width of the object. Type a numeric value to change the width.

Data type: Float

X Specifies the horizontal coordinate of the object's top left corner, relative to its parent container, when the object is not in static position in the container. Type a numeric value to change the coordinate.

Data type: Float
Y Specifies the vertical coordinate of the object's top left corner, relative to its parent container, when the object is not in static position in the container. Type a numeric value to change the coordinate.

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
Foreground Specifies the foreground 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:

@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
Style Specifies 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 CSV Specifies whether to include the object in the CSV output.

Data type: Boolean

Note icon When you set this property to "true", Report Engine only includes text in the output.

Export to Excel Specifies whether to include the object in the Excel output.

Data type: Boolean

Note icon When you set this property to "true", Report Engine only includes text in the output.

Export to HTML Specifies whether to include the object in the HTML output.

Data type: Boolean
Export to PDF Specifies whether to include the object in the PDF output.

Data type: Boolean
Export to PostScript Specifies whether to include the object in the PostScript output.

Data type: Boolean
Export to Report Result Specifies 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 RTF Specifies whether to include the object in the RTF output.

Data type: Boolean
Export to Text Specifies whether to include the object in the Text output.

Data type: Boolean

Note icon When you set this property to "true", Report Engine only includes text in the output.

Export to XML Specifies whether to include the object in the XML output.

Data type: Boolean

Note icon When you set this property to "true", Report Engine only includes text in the output.

Invisible Specifies whether to hide the object in the design area and in the report. Report Engine performs all calculations that involve the object regardless of whether the object is visible or not.

Data type: Boolean
Position Designer 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 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.
  • 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 Specifies whether to suppress the object in the design area and in the report. If you suppress an object, Report Engine skips all formulas and calculations that involve the object. This property has higher priority over Invisible.

Data type: Boolean
Suppress When No Records Specifies whether to suppress the object in the report when no record is returned to its parent data component.

Data type: Boolean
Excel
Column Index Specifies the X coordinate of the object relative to its parent container in the Excel and CSV outputs, measured in cells.

Data type: Integer

Note icon This property takes effect when you set the page report tab's Columned property to "true" and the object's Position property is not "static".

Column Number Specifies the number of columns to determine the width of the object in the Excel and CSV outputs. Type an integer value to change the number.

Data type: Integer

Note icon This property takes effect when you set the page report tab's Columned property to "true".
Row Index Specifies the Y coordinate of the object relative to its parent container in the Excel and CSV outputs, measured in cells.

Data type: Integer

Note icon This property takes effect when you set the page report tab's Columned property to "true" and the object's Position property is not "static".

Row Number Specifies the number of rows to determine the height of the object in the Excel and CSV outputs. Type an integer value to change the number.

Data type: Integer

Note icon This property takes effect when you set the page report tab's Columned property to "true".
Font
Bold Specifies whether to apply bold formatting to the text in the object.

Data type: Boolean
Font Face Specifies the font face of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration
Font Size Specifies the font size of the text in the object. Type an integer value to change the size.

Data type: Integer
Italic Specifies whether to italicize the text in the object.

Data type: Boolean
Accessibility
External CSS Class Selector Specifies the name of the Class Selector for the object in the HTML output.

Data type: String

Note icon Report does not support UDOs in RTF and PDF outputs, meaning, when you export a report containing UDOs to RTF or PDF, Report Engine may not able to render the report correctly. There is no such issue for HTML and PostScript outputs.

Back to top

Properties of the Built-in UDOs

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

Properties of JHyperLink

Property Name Description
Others
Auto Fit Specifies whether to automatically adjust the width of the object according to the hyperlink text.

Data type: Boolean
Display Value Specifies the text you want to display for 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 Name Specifies the class to execute the hyperlink. When you specify to link to a .rst file (the result file for the Report Result output), you should select jet.udos.RPTExecuter. For other links, use jet.udos.IEExecuter.

Data type: String

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

Data type: Enumeration
HTML Style Specifies the CSS style of the object 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

Target Specifies the target window or frame to display the content the hyperlink refers to. Choose an option from the drop-down list.
  • blank
    Select to load the content into a new blank window. This window is not named.
  • self
    Select to load the content into the window in which the hyperlink is (the active window).
  • parent
    Select to load the content into the immediate parent window of the active window. If there is no parent window, the active window is used.
  • top
    Select to load the content into the topmost window.

Data type: Enumeration

Tool Tip Specifies the tool tip that displays when you point to the object in Designer view mode, in HTML output, or in Page Report Studio.

Data type: String

URL Specifies the URL of the hyperlink.

Data type: String

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

Data type: Enumeration
Word Wrap Specifies whether to wrap the text according to the width of the object.

Data type: Boolean
Image
Alternate Text Specifies the text you want to show instead when the image cannot display.

Data type: String

Display Image Specifies the local path of the image you want to display for the hyperlink (like a hotspot in HTML). This property has higher priority than Display Value.

Data type: String

Original Specifies whether to use the original image to run the report on Server. By default (the property being "false"), when you publish the report to Server, Designer delivers the image together with the report, so when you run the report on Server, Server gets the image from its side directly. If you set this property to "true", Designer does not deliver the image when you publish the report, then when you run the report on Server, Server obtains the image from the local directory specified by the Display Image property.

Data type: Boolean

Accessibility
External AccessKey This property is mapped to the HTML attribute accesskey, as specified by w3.org.

Data type: String
External CSS Class Selector Specifies the name of the Class Selector for the object in the HTML output.

Data type: String
HrefLang

This property is mapped to the HTML attribute hreflang, as specified by w3.org. You can use it to specify the base language of the content designated by the hyperlink.

Data type: String

Properties of JRotator

Property Name Description
Others
Display Image Specifies the local path of the image you want to display in the object. This property has higher priority than Display Value.

Data type: String

Display Value Specifies the text you want to display in the object. This property has lower priority than Display Image.

Data type: String
Horizontal Alignment Specifies the horizontal justification of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration
Rotation Specifies the angle at which to rotate the content in the object, in degrees. 0 means no rotation; a positive value means to rotate the content clockwise; a negative value means to rotate the content anticlockwise.

Data type: Float
Vertical Alignment Specifies the vertical justification of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration

Back to top

BackPrevious Topic  Next TopicNext