ObjectAttributeReferenceBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ObjectAttributeReferenceBuilder Class

class `NXOpen.Formboard.``ObjectAttributeReferenceBuilder`

  Bases: `NXOpen.Builder`

  Builder for “object attribute” used in formboard which enbles user to create annotation in drafting functionality.

  It creates a tabular note and displays object attributes of a single object selected by user.

  To create a new instance of this class, use `NXOpen.Formboard.FormboardManager.CreateObjectAttributeReferenceBuilder()`

  Default values.

  Property | Value
  --- | ---
  EnumType | None

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
AnnotLeader | Returns the `Annotations.LeaderBuilder` for the annotation
CompOrigin | Returns the comp origin
EnumType | Returns or sets the enum type
ObjectSelection | Returns the object selected by user to associated annotation
Tag | Returns the Tag for this object.

# 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

ObjectAttributeReferenceBuilderLeaderType Enumeration | Enum which defines types of leader user wants to associate with the annotation.

# Property Detail

## AnnotLeader

`ObjectAttributeReferenceBuilder.``AnnotLeader`

  Returns the `Annotations.LeaderBuilder` for the annotation

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

  Getter Method

  Signature `AnnotLeader`

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

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

## CompOrigin

`ObjectAttributeReferenceBuilder.``CompOrigin`

  Returns the comp origin

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

  Getter Method

  Signature `CompOrigin`

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

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

## EnumType

`ObjectAttributeReferenceBuilder.``EnumType`

  Returns or sets the enum type

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

  Getter Method

  Signature `EnumType`

  Returns: |
  Return type: | `NXOpen.Formboard.ObjectAttributeReferenceBuilderLeaderType`

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

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

  Setter Method

  Signature `EnumType`

  Parameters: | enumType (`NXOpen.Formboard.ObjectAttributeReferenceBuilderLeaderType`) –

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

## ObjectSelection

`ObjectAttributeReferenceBuilder.``ObjectSelection`

  Returns the object selected by user to associated annotation

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

  Getter Method

  Signature `ObjectSelection`

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

  New in version NX7.5.0.

  License requirements: routing_harness (“Routing Harness”)

# Method Detail

## Validate

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