Label Class — NXOpen Python API Reference 12.0.0 documentation

# Label Class

class `NXOpen.BlockStyler.``Label`

  Bases: `NXOpen.BlockStyler.UIBlock`

  Represents a Label

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
BalloonTooltipImage | Returns or sets the BalloonTooltipImage
BalloonTooltipLayoutAsString | Returns or sets the BalloonTooltipLayout as string
BalloonTooltipText | Returns or sets the BalloonTooltipText
Bitmap | Returns or sets the Bitmap
DisplayBitmapLabel | Returns or sets the DisplayBitmapLabel
Enable | Returns or sets the Enable.
Expanded | Returns or sets the Expanded
Group | Returns or sets the Group
HighQualityBitmap | Returns or sets the HighQualityBitmap
Label | Returns or sets the Label
Localize | Returns or sets the Localize.
Name | Returns the name of the block or BlockID
Show | Returns or sets the Visibility of block.
Tag | Returns the Tag for this object.
Tooltip | Returns or sets the Tooltip
Type | Returns the type of block
WordWrap | Returns or sets the WordWrap

# Methods

Method | Description
--- | ---
Focus | Focuses on the block.
GetBalloonTooltipLayoutMembers | Gets the BalloonTooltipLayout members
GetProperties | Returns the properties of the block

# Property Detail

## BalloonTooltipImage

`Label.``BalloonTooltipImage`

  Returns or sets the BalloonTooltipImage

  `-------------------------------------`

  Getter Method

  Signature `BalloonTooltipImage`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `BalloonTooltipImage`

  Parameters: | imageString (str) –

  New in version NX8.5.0.

  License requirements: None.

## BalloonTooltipLayoutAsString

`Label.``BalloonTooltipLayoutAsString`

  Returns or sets the BalloonTooltipLayout as string

  `-------------------------------------`

  Getter Method

  Signature `BalloonTooltipLayoutAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `BalloonTooltipLayoutAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

## BalloonTooltipText

`Label.``BalloonTooltipText`

  Returns or sets the BalloonTooltipText

  `-------------------------------------`

  Getter Method

  Signature `BalloonTooltipText`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `BalloonTooltipText`

  Parameters: | tooltipText (str) –

  New in version NX8.5.0.

  License requirements: None.

## Bitmap

`Label.``Bitmap`

  Returns or sets the Bitmap

  `-------------------------------------`

  Getter Method

  Signature `Bitmap`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Bitmap`

  Parameters: | bitmapString (str) –

  New in version NX8.5.0.

  License requirements: None.

## DisplayBitmapLabel

`Label.``DisplayBitmapLabel`

  Returns or sets the DisplayBitmapLabel

  `-------------------------------------`

  Getter Method

  Signature `DisplayBitmapLabel`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DisplayBitmapLabel`

  Parameters: | display (bool) –

  New in version NX8.5.0.

  License requirements: None.

## HighQualityBitmap

`Label.``HighQualityBitmap`

  Returns or sets the HighQualityBitmap

  `-------------------------------------`

  Getter Method

  Signature `HighQualityBitmap`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `HighQualityBitmap`

  Parameters: | highQuality (bool) –

  New in version NX8.5.0.

  License requirements: None.

## Localize

`Label.``Localize`

  Returns or sets the Localize.

  If true, translates the Label string into the current locale language.

  `-------------------------------------`

  Getter Method

  Signature `Localize`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Localize`

  Parameters: | localize (bool) –

  New in version NX8.5.0.

  License requirements: None.

## Tooltip

`Label.``Tooltip`

  Returns or sets the Tooltip

  `-------------------------------------`

  Getter Method

  Signature `Tooltip`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Tooltip`

  Parameters: | tooltipString (str) –

  New in version NX8.5.0.

  License requirements: None.

## WordWrap

`Label.``WordWrap`

  Returns or sets the WordWrap

  `-------------------------------------`

  Getter Method

  Signature `WordWrap`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `WordWrap`

  Parameters: | wordwrap (bool) –

  New in version NX8.5.0.

  License requirements: None.

# Method Detail

## GetBalloonTooltipLayoutMembers

`Label.``GetBalloonTooltipLayoutMembers`

  Gets the BalloonTooltipLayout members

  Signature `GetBalloonTooltipLayoutMembers()`

  Returns: | Values to get from the property
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.