WeldLabelBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# WeldLabelBuilder Class

class `NXOpen.Weld.``WeldLabelBuilder`

  Bases: `NXOpen.Builder`

  Create weld labels for multiple welds and BIW locators, this builder’s Commit can produce more than one object, the GetCommittedObjects can be used to get the objects and the order of GetCommittedObject’s output array is stable.

  To create a new instance of this class, use `NXOpen.Weld.WeldManager.CreateWeldLabelBuilder()`

  Default values.

  Property | Value
  --- | ---
  IncludeLeader | 1
  Text.TextBlock.CustomSymbolScale | 1.0
  Text.TextBlock.SymbolAspectRatio | 1.0
  Text.TextBlock.SymbolHeight | 25.4 (millimeters part), 1.0 (inches part)
  Text.TextBlock.SymbolLength | 25.4 (millimeters part), 1.0 (inches part)
  Text.TextBlock.SymbolPreferences | UseCurrent
  Text.TextBlock.SymbolScale | 1.0
  Text.TextBlock.SymbolSizeMethod | ScaleAndAspectRatio

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
IncludeLeader | Returns or sets the leader option, indicates whether to create a leader
Leader | Returns the `NXOpen.Annotations.LeaderBuilder` for the annotation
Objects | Returns the objects that are used to create labels.
Origin | Returns the `NXOpen.Annotations.OriginBuilder` for the annotation
PlaneType | Returns or sets the plane type.
Style | Returns the `NXOpen.Annotations.StyleBuilder` for the annotation
Tag | Returns the Tag for this object.
Text | Returns the `NXOpen.Annotations.TextWithEditControlsBuilder` for the annotation
UserCsys | Returns or sets the user specified coordinate system.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

WeldLabelBuilderOrientationPlaneType Enumeration | This represents the Orientation Plane Type.

# Property Detail

## IncludeLeader

`WeldLabelBuilder.``IncludeLeader`

  Returns or sets the leader option, indicates whether to create a leader

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

  Getter Method

  Signature `IncludeLeader`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `IncludeLeader`

  Parameters: | leader (bool) –

  New in version NX8.5.0.

  License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)

## Leader

`WeldLabelBuilder.``Leader`

  Returns the `NXOpen.Annotations.LeaderBuilder` for the annotation

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

  Getter Method

  Signature `Leader`

  Returns: |
  Return type: | `NXOpen.Annotations.LeaderBuilder`

  New in version NX8.5.0.

  License requirements: None.

## Objects

`WeldLabelBuilder.``Objects`

  Returns the objects that are used to create labels.

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

  Getter Method

  Signature `Objects`

  Returns: |
  Return type: | `NXOpen.SelectNXObjectList`

  New in version NX8.5.0.

  License requirements: None.

## Origin

`WeldLabelBuilder.``Origin`

  Returns the `NXOpen.Annotations.OriginBuilder` for the annotation

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

  Getter Method

  Signature `Origin`

  Returns: |
  Return type: | `NXOpen.Annotations.OriginBuilder`

  New in version NX8.5.0.

  License requirements: None.

## PlaneType

`WeldLabelBuilder.``PlaneType`

  Returns or sets the plane type.

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

  Getter Method

  Signature `PlaneType`

  Returns: |
  Return type: | `NXOpen.Weld.WeldLabelBuilderOrientationPlaneType`

  New in version NX8.5.2.

  License requirements: None.

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

  Setter Method

  Signature `PlaneType`

  Parameters: | planeType (`NXOpen.Weld.WeldLabelBuilderOrientationPlaneType`) –

  New in version NX8.5.2.

  License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)

## Style

`WeldLabelBuilder.``Style`

  Returns the `NXOpen.Annotations.StyleBuilder` for the annotation

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

  Getter Method

  Signature `Style`

  Returns: |
  Return type: | `NXOpen.Annotations.StyleBuilder`

  New in version NX8.5.0.

  License requirements: None.

## Text

`WeldLabelBuilder.``Text`

  Returns the `NXOpen.Annotations.TextWithEditControlsBuilder` for the annotation

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

  Getter Method

  Signature `Text`

  Returns: |
  Return type: | `NXOpen.Annotations.TextWithEditControlsBuilder`

  New in version NX8.5.0.

  License requirements: None.

## UserCsys

`WeldLabelBuilder.``UserCsys`

  Returns or sets the user specified coordinate system.

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

  Getter Method

  Signature `UserCsys`

  Returns: |
  Return type: | `NXOpen.CoordinateSystem`

  New in version NX8.5.2.

  License requirements: None.

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

  Setter Method

  Signature `UserCsys`

  Parameters: | userCsys (`NXOpen.CoordinateSystem`) –

  New in version NX8.5.2.

  License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)

# Method Detail

## Validate

`WeldLabelBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.