Skip to main content

Label

  • Updated

BackPrevious Topic  Next TopicNext

Label

The properties of a label object are:

Property NameDescription
General
Display Name Specifies the display name of the object.

Data type: String

Instance Name Shows the instance name of the object. This property is read only.
ReferenceShows the instance name of the field if the label is related to a field. This property is read only.
Geometry
HeightSpecifies the height of the object, in inches. Enter a numeric value to change the height.

Data type: Float

WidthSpecifies the width of the object, in inches. 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 unavailable if the Position property is set to static. Enter a numeric value to change the position in inches. Not available when the label is in a crosstab.

Data type: Float

YSpecifies the vertical coordinate of the top left corner of the object, relative to its parent container. This property is unavailable if the Position property is set to static. Enter a numeric value to change the position in inches. Not available when the label is in a crosstab.

Data type: Float

Color
BackgroundSpecifies the background color of the object. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog. You can also 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 define a color in the Color Picker dialog. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Text Format
Auto FitSpecifies whether to adjust the width and height of the object according to the contents. For performance concern, it is recommended that you do not set both Auto Fit and Word Wrap to true when the label is in a crosstab.

Data type: Boolean

Auto Map Field NameEnabled when the label is related to a field. It specifies whether to automatically map the label text to the dynamic display name of the field. If true, the text specified via the Text property will be ignored.

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

ItalicSpecifies whether to make the text italic.

Data type: Boolean

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. For performance concern, it is recommended that you do not set both Auto Fit and Word Wrap to true when the label is in a crosstab.

Data type: Boolean

Border
Border ColorSpecifies the color of the border of the object. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border ThicknessSpecifies the width of the border in inches. 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

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

Data type: Enumeration

Padding
Bottom PaddingSpecifies the space between the text and the bottom border of the object, in inches. 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, in inches. 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, in inches. 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, in inches. Enter a numeric value to change the padding.

Data type: Float

Others
Export to CSV Specifies whether to include the object when exporting the report to CSV.

Data type: Boolean

Export to ExcelSpecifies whether to include the object when exporting the report to Excel.

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.

Data type: Boolean

Export to PostScriptSpecifies whether to include the object when exporting the report to PostScript.

Data type: Boolean

Export to Report ResultSpecifies whether to include the object in Web Report Studio or when the report is opened in Web Report Result.

Data type: Boolean

Export to RTFSpecifies whether to include the object when exporting the report to RTF.

Data type: Boolean

Export to Text Specifies whether to include the object when exporting the report to Text.

Data type: Boolean

Export to XML Specifies whether to include the object when exporting the report to XML.

Data type: Boolean

InvisibleSpecifies whether to show or hide the object. All formulas and calculations will still be performed if the property is set to true. For an independent label, you can also use a formula to control whether or not to show it. Not available when the label is in a crosstab.

Data type: Boolean

PositionSpecifies the position of the object. Available when the label is directly contained in the report body or a tabular cell.
  • absolute - The object's position will be decided by its X and Y property values.
  • static - The object will be positioned at the default location in its container. If selected, the X, Y and other position-related properties will be hidden or disabled.

Data type: Enumeration

Suppress Aggregate This property is supported on labels (excluding summary labels) that are inside a crosstab only. It specifies whether to hide the Total row or column.

Data type: Boolean

BackPrevious Topic  Next TopicNext