ObjectConnectionDetailBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ObjectConnectionDetailBuilder Class

class `NXOpen.AME.``ObjectConnectionDetailBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  JA class for the reuse object connection detail block

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
PropertyString | Returns or sets the selected property name
ResultString | Returns the result string text
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
ChangeEditObject | Change the edit object
Populate | Populate selection
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## PropertyString

`ObjectConnectionDetailBuilder.``PropertyString`

  Returns or sets the selected property name

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

  Getter Method

  Signature `PropertyString`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Setter Method

  Signature `PropertyString`

  Parameters: | propertyName (str) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## ResultString

`ObjectConnectionDetailBuilder.``ResultString`

  Returns the result string text

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

  Getter Method

  Signature `ResultString`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

# Method Detail

## ChangeEditObject

`ObjectConnectionDetailBuilder.``ChangeEditObject`

  Change the edit object

  Signature `ChangeEditObject(newObject)`

  Parameters: | newObject (`NXOpen.NXObject`) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## Populate

`ObjectConnectionDetailBuilder.``Populate`

  Populate selection

  Signature `Populate(hierarchy)`

  Parameters: | hierarchy (list of str) –

  New in version NX12.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## Validate

`ObjectConnectionDetailBuilder.``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.