Skip to main content

Properties of Label in Page Report

  • Updated

Previous Topic  Next Topic

Properties of Label in Page Report

The properties of a label object in a page report are:

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.
Text Format
Auto FitSpecifies whether to adjust the width and height of the object according to the contents.

Data type: Boolean

BoldSpecifies whether to make the text bold.

Data type: Boolean

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

Data type: Enumeration

Font SizeSpecifies the font size of the text. Enter an integer value to change the size.

Data type: Integer

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

Data type: Enumeration

Ignore HTML TagSpecifies whether or not to ignore the HTML tags when exporting the report results to HTML format.
  • true - The text will appear in the HTML file the same as that in Logi JReport Designer (HTML tag elements in the text, if any, will not be parsed).
  • false - HTML tag elements in the text will be parsed when exporting the report results to HTML format.

This property is useful for exporting the report results to HTML format. You may want to write the label contents in HTML tags in your report, and for the exported HTML files, the tags will be transferred as they are translated into HTML.

Data type: Boolean

ItalicSpecifies whether to make the text italic.

Data type: Boolean

Maximum WidthSpecifies the maximum width of the text displayed. Enter a numeric value to change the width.

This property often works with the Auto Fit property. If Auto Fit = true and Maximum Width is not equal to 0, the text will extend until the width is this value.

Data type: Float

StrikethroughSpecifies whether to add a strikethrough line to the text.

Data type: Boolean

TextSpecifies the text in the label. Enter a string to display as the label text.

Data type: String

UnderlineSpecifies whether to underline the text.

Data type: Boolean

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

Data type: Enumeration

Word WrapSpecifies whether to wrap the text to the width.

Data type: Boolean

Geometry
HeightSpecifies the height of the object. Enter a numeric value to change the height.

Data type: Float

WidthSpecifies the width of the object. Enter a numeric value to change the width.

Data type: Float

XSpecifies the horizontal coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position.

Data type: Float

YSpecifies the vertical coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position.

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 enter 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 enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

CSS
ClassSpecifies a CSS class to be applied to the object which is a valid class in the CSS file.

Data type: String

IDSpecifies the identifier of the object, which must be unique in the report. The ID property can be a style sheet selector.

Data type: String

StyleThe 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. Enter a valid class name from the CSS file.

Data type: String

Excel
Column IndexSpecifies the X coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the report tab level must be set to true for this property to take effect.

Data type: Integer

Row IndexSpecifies the Y coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the report tab level must be set to true for this property to take effect.

Data type: Integer

Padding
Bottom PaddingSpecifies the space between the text and the bottom border of the object. Enter a numeric value to change the padding.

Data type: Float

Left PaddingSpecifies the space between the text and the left border of the object. Enter a numeric value to change the padding.

Data type: Float

Right PaddingSpecifies the space between the text and the right border of the object. Enter a numeric value to change the padding.

Data type: Float

Top PaddingSpecifies the space between the text and the top border of the object. Enter a numeric value to change the padding.

Data type: Float

Border
Border ColorSpecifies 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 use a formula or edit an expression that returns a color, or enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border ThicknessSpecifies the width of the border. Enter a numeric value to change the thickness.

Data type: Float

Bottom LineSpecifies the line style of the bottom border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Left LineSpecifies the line style of the left border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Right LineSpecifies the line style of the right border of the object. Choose a style from the drop-down list.

Data type: Enumeration

ShadowSpecifies whether to draw two shadowed borders, beneath and to the right of the object.

Data type: Boolean

Shadow ColorSpecifies the color of the shadow. 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 enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Top LineSpecifies the line style of the top border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Pattern
Pattern ColorSpecifies the color in which to draw a pattern to fill 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 enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Pattern StyleSpecifies the style of the pattern. Choose an option from the drop-down list.
  • none - No pattern will be applied to the object.
  • 50% - The object will be filled in the Pattern Color of 50%-transparency.
  • horizontal - The pattern will be made of horizontal lines of the Pattern Color.
  • vertical - The pattern will be made of vertical lines of the Pattern Color.
  • grid - The pattern will be an overlapping of horizontal and vertical lines of the Pattern Color.
  • diagonal - The pattern will be made of diagonal lines of the Pattern Color.

Data type: Enumeration

Others
Bind ColumnSpecifies to bind the label with a field so that end users can use the label's shortcut menu to filter and sort records of the bound field in Page Report Studio. When a label is bound with a field, you can further set the label's Filterable and Sortable properties to true to display the corresponding buttons beside the label for easy filtering and sorting. For more information, see Enabling Sort and Filter on Labels.

Data type: String

Detail ReportSpecifies the detail report that the object is linked to. Select in the value cell to set the detail report. For details, refer to Linking to a Detail Report.

Data type: String

Detail Target FrameSpecifies the target window or frame in which to display the detailed information. This property is enabled only when Go To Detail is set to true. Choose an option from the drop-down list.
  • <Server Setting>
    Loads the detailed information according to setting of the Pop Up New Window for Links option in the Customize Profile panel of the Profile dialog in Logi JReport Server.
  • New Window
    Loads the detailed information into a new window. The window is not named.
  • Whole Window
    Loads the detailed information into the full browser window.
  • Same Frame
    Loads the detailed information into the same frame as the object.
  • Parent Frame
    Loads the detailed information into the parent frame of the frame in which the object is.
  • Other Frame
    Loads the detailed information into some other specified frame. If selected, you can also directly input the name of the frame you have defined in the text box. If the frame name does not exist, the detailed information will be loaded into a new window.

Data type: String

Enable Hyperlink in ExcelSpecifies whether to enable the link defined on the object when exporting the report to an Excel file.

Data type: Boolean

Enable Hyperlink in HTMLSpecifies whether to enable the link defined on the object when exporting the report to an HTML file.

Data type: Boolean

Enable Hyperlink in PDFSpecifies whether to enable the link defined on the object when exporting the report to a PDF file.

Data type: Boolean

Export to AppletSpecifies whether to include the object when exporting the report to Applet.

Data type: Boolean

Export to CSVSpecifies whether to include the object when exporting the report to CSV. If it is set to true, only the string value will be exported when the object is displayed as a barcode or text field, and only the text will be exported when the object is displayed as a checkbox, radio button or button.

Data type: Boolean

Export to ExcelSpecifies whether to include the object when exporting the report to Excel. If it is set to true, only the string value will be exported when the object is displayed as a text field.

Data type: Boolean

Export to HTMLSpecifies whether to include the object when exporting the report to HTML.

Data type: Boolean

Export to PDFSpecifies whether to include the object when exporting the report to PDF. If it is set to true, only the string value will be exported when the object is displayed as a text field.

Data type: Boolean

Export to PostScriptSpecifies whether to include the object when exporting the report to PostScript. If it is set to true, only the string value will be exported when the object is displayed as a text field.

Data type: Boolean

Export to Report ResultSpecifies whether to include the object when exporting the report to Report Result.

Data type: Boolean

Export to RTF Specifies whether to include the object when exporting the report to RTF. If it is set to true, only the string value will be exported when the object is displayed as a text field, and only the text will be exported when the object is displayed as a radio button or button.

Data type: Boolean

Export to TextSpecifies whether to include the object when exporting the report to Text. If it is set to true, only the string value will be exported when the object is displayed as a barcode or text field, and only the text will be exported when the object is displayed as a checkbox, radio button or button.

Data type: Boolean

Export to XML Specifies whether to include the object when exporting the report to XML. If it is set to true, only the string value will be exported when the object is displayed as a barcode or text field, and only the text will be exported when the object is displayed as a checkbox, radio button or button.

Data type: Boolean

Filter OptionsWhen the label has a Bind Column, you can set this property to specify the filter-related options that will be displayed on the Filter submenu when right-clicking the label in Page Report Studio. For more information, refer to Setting Filter Options for an Object.

Data type: Integer

FilterableIf true, a filter button appears beside the label when viewing the report in Page Report Studio. You can use the button to filter the records based on values of the field specified via the Bind Column property. For more information, see Enabling Sort and Filter on Labels.

Data type: Boolean

Go to DetailSpecifies whether to show the detailed information when you select the object in Page Report Studio. This property is available only when the object is in the group header/footer panel of a banded object. For details about its usage, refer to Obtaining Detailed Information from a Banded Object.

Data type: Boolean

InvisibleSpecifies whether to show the object in the design area and in the report results. All formulas and calculations will still be performed if the property is set to true.

Data type: Boolean

LinkSpecifies to link the object to another report, a website, an e-mail address or a Blob data type field. Select in the value cell to set the link target. For details, see Binding a Link to a Label.

Data type: String

Logic ColumnSpecifies whether to show the object in the next visible table cell in the same row when the column which holds the object is hidden. Available to labels in table only. Choose an option from the drop-down list.

Data type: Enumeration

Notes:

  • The next visible table cell should be completely empty, that is, the cell should not hold any content including blank space.
  • When the property for several objects in the same row is set to next visible column, and the columns holding these objects are all hidden, then only the object in the rightmost column will be shown in the next visible cell.
PositionSpecifies the position of the object. Choose an option from the drop-down list.
  • static - The object is positioned at the location in which it is inserted. If selected, the X, Y and other position-related properties will be hidden or disabled. The position of the object is affected by preceding objects in the same container.
  • relative - The object is positioned at an offset to the position at which it is inserted. The offset is determined by the X and Y property values.
  • absolute - The object will be located at the position specified by dragging and dropping or by setting its X and Y property values. The position of the object is not affected by preceding objects in the same container.

Data type: Enumeration

Record LocationSpecifies the calculation point for the properties which use 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

SortableIf true, a sort button appears beside the label when viewing the report in Page Report Studio. You can use the button to arrange the records of a specific field in ascending or descending order. The field is specified via the Bind Column property. For more information, see Enabling Sort and Filter on Labels.

Data type: Boolean

SuppressSpecifies whether to show the object in the design area and in the report results. All formulas and calculations will be skipped if the property is set to true.

Data type: Boolean

Note: When both the Invisible and Suppress properties of an object are set to true, Suppress has the higher priority.

Suppress When No RecordsSpecifies whether to display the object in the report results when no record is returned to its parent data component.

Data type: Boolean

Transfer StyleSpecifies whether the style group of the primary report will be applied to the linked report if the object is linked to a report.

Data type: Boolean

TOC
Anchor Display ValueSpecifies a string or formula to display for the TOC entry for this object in the TOC Browser. By default it is the value of the specified object. The TOC Anchor property must be set to true for this property to take effect.

Data type: String

TOC AnchorSpecifies whether to include the object in the TOC Browser for 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. Enter a valid class name from the CSS file.

Data type: String

External DirIt is mapped to the HTML attribute dir. This attribute specifies the base direction of directionally neutral text in the object's content and attribute values. It also specifies the directionality of tables. Possible values:
  • LTR - Left-to-right text or table.
  • RTL - Right-to-left text or table.

Data type: String

External IDIt 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 StyleIt is mapped to the HTML attribute style. This attribute specifies style information for the object.

Data type: String

External TabIndexIt is mapped to the HTML attribute tabindex. This attribute specifies the position of the object in the tabbing order for the current report. Enter an integer equal to or greater than 0 and less than 65535.

Data type: Integer

External TitleIt is mapped to the HTML attribute title. This attribute offers advisory information about the object.

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

LanguageIt 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

LongDescIt is mapped to the HTML attribute longdesc. This attribute specifies a link to a long description of the object.

Data type: String

Auto Fit , Maximum Width, Word Wrap

Here is a label:
Label product sales by region

We want to show it as:
Label product
sales by region

We can set the following:

  • Auto Fit: true
  • Maximum Width: 1
  • Word Wrap: true

Auto Fit=true enables the contents to grow horizontally but stop when the width becomes 1. Word Wrap=true enables the remaining contents to wrap downward if no space is left horizontally.

Style, ID, Class

The following is an example of using the Style, ID, Class property values as style sheet selectors in a CSS style file:

NewCSSFile.css:

@charset "GBK";
TextField {Background: #ff0000}
/*Style=LabelX*/
TextField[Style="LabelX"]{Background: #0000FF}
/*ID=W*/
TextField#W{Background: #FFFF00}
/*class=C*/
TextField.C{Background: #00FFFF}

Record Location

This property is to specify the calculation point for the properties of the object. Here is an example:

A report specifies to display Continued on Next Page for every page that has another following it. If this label is inserted in the PageHeader/PageFooter, then every page including the last page will contain the message. There is a way to write formulas that can resolve the problem:

Continue1:
global boolean j=true;
j=false;

Continue2:
pagenumber;
j=true;

Continue3:
pagenumber;
return j;

Insert Continue1 into the ReportHeader, Continue2 into the ReportFooter. To track the calculation, you can insert Continue3 into the PageFooter. If you do not want to see these formulas in view mode, you can suppress them.

Insert label Continued on Next Page in the PageHeader, and use Continue3 to control its property Invisible.

Set the property Record Location of the above label to be Page Footer, so that Continue3 returns value which is calculated in the PageFooter instead of in the PageHeader.

PageNumber is included in the formula to force it to execute as a page level formula in the order the formula is encountered rather than at the end of a group or report. For more information, see Formula Levels.

Previous Topic  Next Topic

Related articles

Comments

0 comments

Please sign in to leave a comment.