ObjectAttributeManagementBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ObjectAttributeManagementBuilder Class

class `NXOpen.Tooling.``ObjectAttributeManagementBuilder`

  Bases: `NXOpen.Builder`

  Tooling builder to assign and edit attributes of objects

  To create a new instance of this class, use `NXOpen.Tooling.ObjectAttributeManagementCollection.CreateObjectAttributeManagementBuilder()`

  Default values.

  Property | Value
  --- | ---
  AttributeOfRootPart | 0
  SelectionFilter | Component
  SelectionFilterAccordingToAttribute | Component
  ShowTypeEnum | ShowAllComponents
  ToggleListDependents | 0
  Type | ShowObjectAccordingToAttribute

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
AttributeOfRootPart | Returns or sets the option whether to show attributes of root part
AttributeTitles | Returns or sets the attribute titles
AttributeValues | Returns or sets the attribute values
SelectAttributeSpreadsheet | Returns or sets the selected attribute spreadsheet
SelectBody | Returns the select body
SelectBodyAccordingToAttribute | Returns the select body according to attribute
SelectComponent | Returns the selected objects
SelectComponentAccordingToAttribute | Returns the objects according to attributes
SelectFace | Returns the select face
SelectFaceAccordingToAttribute | Returns the faces according to attribute
SelectionFilter | Returns or sets the selection filter
SelectionFilterAccordingToAttribute | Returns or sets the selection filter according to attribute
ShowTypeEnum | Returns or sets the show type enumeration
Tag | Returns the Tag for this object.
ToggleListDependents | Returns or sets the option whether to list dependent components
Type | Returns or sets the type show objects or attributes
WizardType | Returns or sets the wizard type

# Methods

Method | Description
--- | ---
AddFromDataFileAttributeList | The action to add selected attributes from attributes spreadsheet
Commit | Commits any edits that have been applied to the builder.
CopyAttribute | The action to copy selected attributes
DeleteAttribute | The action to delete selected attributes
Destroy | Deletes the builder, and cleans up any objects created by the builder.
EditConfigurationFile | Tha action to edit attribute spreadsheet
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.
NewAttribute | The action to new an attribute
PasteAttribute | The action to paste copied attributes
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UndoButton | The action to undo last delete
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

ObjectAttributeManagementBuilderFilterAccordingToAttributeType Enumeration | the selection filter type according to attribute
ObjectAttributeManagementBuilderFilterType Enumeration | the selection filter type
ObjectAttributeManagementBuilderShowComponentsType Enumeration | the show type according to attribute
ObjectAttributeManagementBuilderShowType Enumeration | show attributes of selected objects or show objects according to attribute

# Property Detail

## AttributeOfRootPart

`ObjectAttributeManagementBuilder.``AttributeOfRootPart`

  Returns or sets the option whether to show attributes of root part

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

  Getter Method

  Signature `AttributeOfRootPart`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AttributeOfRootPart`

  Parameters: | attributeOfRootPart (bool) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## AttributeTitles

`ObjectAttributeManagementBuilder.``AttributeTitles`

  Returns or sets the attribute titles

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

  Getter Method

  Signature `AttributeTitles`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AttributeTitles`

  Parameters: | attributeTitles (str) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## AttributeValues

`ObjectAttributeManagementBuilder.``AttributeValues`

  Returns or sets the attribute values

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

  Getter Method

  Signature `AttributeValues`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AttributeValues`

  Parameters: | attributeValues (str) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## SelectAttributeSpreadsheet

`ObjectAttributeManagementBuilder.``SelectAttributeSpreadsheet`

  Returns or sets the selected attribute spreadsheet

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

  Getter Method

  Signature `SelectAttributeSpreadsheet`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SelectAttributeSpreadsheet`

  Parameters: | fileName (str) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## SelectBody

`ObjectAttributeManagementBuilder.``SelectBody`

  Returns the select body

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

  Getter Method

  Signature `SelectBody`

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

  New in version NX9.0.0.

  License requirements: None.

## SelectBodyAccordingToAttribute

`ObjectAttributeManagementBuilder.``SelectBodyAccordingToAttribute`

  Returns the select body according to attribute

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

  Getter Method

  Signature `SelectBodyAccordingToAttribute`

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

  New in version NX9.0.0.

  License requirements: None.

## SelectComponent

`ObjectAttributeManagementBuilder.``SelectComponent`

  Returns the selected objects

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

  Getter Method

  Signature `SelectComponent`

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

  New in version NX9.0.0.

  License requirements: None.

## SelectComponentAccordingToAttribute

`ObjectAttributeManagementBuilder.``SelectComponentAccordingToAttribute`

  Returns the objects according to attributes

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

  Getter Method

  Signature `SelectComponentAccordingToAttribute`

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

  New in version NX9.0.0.

  License requirements: None.

## SelectFace

`ObjectAttributeManagementBuilder.``SelectFace`

  Returns the select face

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

  Getter Method

  Signature `SelectFace`

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

  New in version NX9.0.0.

  License requirements: None.

## SelectFaceAccordingToAttribute

`ObjectAttributeManagementBuilder.``SelectFaceAccordingToAttribute`

  Returns the faces according to attribute

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

  Getter Method

  Signature `SelectFaceAccordingToAttribute`

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

  New in version NX9.0.0.

  License requirements: None.

## SelectionFilter

`ObjectAttributeManagementBuilder.``SelectionFilter`

  Returns or sets the selection filter

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

  Getter Method

  Signature `SelectionFilter`

  Returns: |
  Return type: | `NXOpen.Tooling.ObjectAttributeManagementBuilderFilterType`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SelectionFilter`

  Parameters: | selectionFilter (`NXOpen.Tooling.ObjectAttributeManagementBuilderFilterType`) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## SelectionFilterAccordingToAttribute

`ObjectAttributeManagementBuilder.``SelectionFilterAccordingToAttribute`

  Returns or sets the selection filter according to attribute

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

  Getter Method

  Signature `SelectionFilterAccordingToAttribute`

  Returns: |
  Return type: | `NXOpen.Tooling.ObjectAttributeManagementBuilderFilterAccordingToAttributeType`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SelectionFilterAccordingToAttribute`

  Parameters: | selectionFilterAccordingToAttribute (`NXOpen.Tooling.ObjectAttributeManagementBuilderFilterAccordingToAttributeType`) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## ShowTypeEnum

`ObjectAttributeManagementBuilder.``ShowTypeEnum`

  Returns or sets the show type enumeration

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

  Getter Method

  Signature `ShowTypeEnum`

  Returns: |
  Return type: | `NXOpen.Tooling.ObjectAttributeManagementBuilderShowComponentsType`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShowTypeEnum`

  Parameters: | showComponentsTypeEnum (`NXOpen.Tooling.ObjectAttributeManagementBuilderShowComponentsType`) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## ToggleListDependents

`ObjectAttributeManagementBuilder.``ToggleListDependents`

  Returns or sets the option whether to list dependent components

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

  Getter Method

  Signature `ToggleListDependents`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ToggleListDependents`

  Parameters: | toggleListDependents (bool) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## Type

`ObjectAttributeManagementBuilder.``Type`

  Returns or sets the type show objects or attributes

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

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.Tooling.ObjectAttributeManagementBuilderShowType`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Tooling.ObjectAttributeManagementBuilderShowType`) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## WizardType

`ObjectAttributeManagementBuilder.``WizardType`

  Returns or sets the wizard type

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

  Getter Method

  Signature `WizardType`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WizardType`

  Parameters: | wizardType (int) –

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

# Method Detail

## AddFromDataFileAttributeList

`ObjectAttributeManagementBuilder.``AddFromDataFileAttributeList`

  The action to add selected attributes from attributes spreadsheet

  Signature `AddFromDataFileAttributeList()`

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## CopyAttribute

`ObjectAttributeManagementBuilder.``CopyAttribute`

  The action to copy selected attributes

  Signature `CopyAttribute()`

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## DeleteAttribute

`ObjectAttributeManagementBuilder.``DeleteAttribute`

  The action to delete selected attributes

  Signature `DeleteAttribute()`

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## EditConfigurationFile

`ObjectAttributeManagementBuilder.``EditConfigurationFile`

  Tha action to edit attribute spreadsheet

  Signature `EditConfigurationFile()`

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## NewAttribute

`ObjectAttributeManagementBuilder.``NewAttribute`

  The action to new an attribute

  Signature `NewAttribute()`

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## PasteAttribute

`ObjectAttributeManagementBuilder.``PasteAttribute`

  The action to paste copied attributes

  Signature `PasteAttribute()`

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## UndoButton

`ObjectAttributeManagementBuilder.``UndoButton`

  The action to undo last delete

  Signature `UndoButton()`

  New in version NX9.0.0.

  License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

## Validate

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