Label

The header of a total row or column, the display name of a column or row field, and the display name of an aggregate field are represented as labels in the Report Structure panel of the Report Inspector. Their class types are CTTextField, CTDBTitleField, and CTLabelField respectively.

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

Property Name Description
General
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.
Text Format
Bold Specifies 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. Enter an integer value to change the size.

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

Data type: Enumeration

Ignore HTML Tag Specifies 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 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
Italic Specifies whether to make the text italic.

Data type: Boolean

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

Data type: Float

Strikethrough Specifies whether to add a strikethrough line to the text.

Data type: Boolean

Text Specifies the text in the label. Enter a string to display as the label text.

Data type: String
Underline Specifies whether to underline the text.

Data type: Boolean

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 to the width.

Data type: Boolean

Color
Background Specifies the background color of the object. Choose a color from the drop-down list, enter a hexadecimal RGB value (e.g. 0xff0000), choose a formula that returns a color, or select Custom from the drop-down list to specify the color.

Data type: String

Foreground Specifies the foreground color of the object. Choose a color from the drop-down list, enter a hexadecimal RGB value (e.g. 0xff0000), choose a formula that returns a color, or select Custom from the drop-down list to specify the 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
ID Specifies the identifier of the object, which must be unique in the report. The ID property can be a style sheet selector.

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

Data type: String
Padding
Bottom Padding Specifies the space in inches or centimeters between the text and the bottom border of the object. Enter a numeric value to change the padding.

Data type: Float
Left Padding Specifies the space in inches or centimeters between the text and the left border of the object. Enter a numeric value to change the padding.

Data type: Float

Right Padding Specifies the space in inches or centimeters between the text and the right border of the object. Enter a numeric value to change the padding.

Data type: Float

Top Padding Specifies the space in inches or centimeters between the text and the top border of the object. Enter a numeric value to change the padding.

Data type: Float

Border
Border Color Specifies the color of the border of the object. Choose a color from the drop-down list, enter a hexadecimal RGB value (0xCCAA00), choose a formula that returns a color, or select Custom from the drop-down list to specify the color.

Data type: String
Border Thickness Specifies the width of the border in inches or centimeters. Enter a numeric value to change the thickness.

Data type: Float

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

Data type: Enumeration

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

Data type: Enumeration
Right Line Specifies the line style of the right border of the object. Choose a style from the drop-down list.

Data type: Enumeration
Shadow Specifies whether to draw two shadowed borders, beneath and to the right of the object.

Data type: Boolean
Shadow Color Specifies the color of the shadow. Choose a color from the drop-down list, enter a hexadecimal RGB value (e.g. 0xff0000), choose a formula that returns a color, or select Custom from the drop-down list to specify the color and fill effect.

Data type: String

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

Data type: Enumeration

Pattern
Pattern Color Specifies the color in which to draw a pattern to fill the object. Choose a color from the drop-down list, enter a hexadecimal RGB value (e.g. 0xff0000), choose a formula that returns a color, or select Custom from the drop-down list to specify the color and fill effect.

Data type: String

Pattern Style Specifies 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 Column When the label's Sortable or Filterable property is set to true, you need specify a field as the value so that the records of the field can be sorted or filtered via the proper button beside the label when viewing the report in Page Report Studio.

Data type: String
Detail Target Frame Specifies 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 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 Excel Specifies whether to enable the hyperlink when exporting the report to an Excel file.

Data type: Boolean
Enable Hyperlink in HTML Specifies whether to enable the hyperlink when exporting the report to an HTML file.

Data type: Boolean
Enable Hyperlink in PDF Specifies whether to enable the hyperlink when exporting the report to a PDF file.

Data type: Boolean
Export to CSV Specifies whether to include the object when exporting the report to CSV.

Data type: Boolean.
Export to Excel Specifies whether to include the object when exporting the report to Excel.

Data type: Boolean
Export to Page Report Result Specifies whether to include the object when exporting the report to Page Report Result.

Data type: Boolean
Export to PDF Specifies whether to include the object when exporting the report to PDF.

Data type: Boolean
Filter Options Specifies the filter-related options that will be displayed on the shortcut menu when right-clicking the object in Page Report Studio.

If Default is selected, the filter options displayed will be determined by the setting in the Profile dialog in JReport Server (Profile > Customize Profile > Page Report Studio > Properties > Default > Filter Menu).

For more information, refer to Setting filter options for a field.

Data type: Integer

Filterable Specifies whether the records can be filtered. If 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 a specific field's value. The field is specified via the Bind Column property.

Data type: Boolean
Go to Detail Specifies whether to show the detailed information when you click 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

Invisible Specifies 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
Link Specifies to link the object to another report, a website, or an e-mail address. Click in the value cell to set the link target. For details, see Binding a link to a label.

Data type: String
Record Location Specifies 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
Sortable Specifies whether the records can be sorted. If 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.

Data type: Boolean
Suppress Specifies 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 Aggregate Specifies whether to hide the Total row or column. Not applicable for CTLabelField.

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

Data type: Boolean
Transfer Style Specifies 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
Accessibility
Abbr It is mapped to the HTML attribute abbr. This attribute specifies an abbreviated form of the content of the object. The abbreviated text may be rendered by user agents when appropriate in place of the object's content.

Data type: String
Axis It is mapped to the HTML attribute axis. This attribute is used to place a cell into conceptual categories that can be considered to form axes in an n-dimensional space. The value of this attribute is a comma-separated list of category names.

Data type: String
External AccessKey It is mapped to the HTML attribute accesskey. This attribute specifies an access key to the object.

Data type: String
External CSS Class Selector Specifies 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 Dir It 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 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 TabIndex It 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 Title It is mapped to the HTML attribute title. This attribute offers advisory information about the object.

Data type: String
Headers It is mapped to the HTML attribute headers. This attribute specifies the list of header cells that provide header information for the current data cell. The value of this attribute is a space-separated list of cell names; those cells must be named by setting their id attribute.

Data type: String
HrefLang It 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
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
LongDesc It is mapped to the HTML attribute longdesc. This attribute specifies a link to a long description of the object.

Data type: String
Scope It is mapped to the HTML attribute scope. This attribute specifies the set of data cells for which the current header cell provides header information. Available values are:
  • Row - The current cell provides header information for the rest of the row that contains it.
  • Column - The current cell provides header information for the rest of the column that contains it.
  • none - The scope attribute will not be generated when exporting to HTML.

Data type: String