PartOperationAttributePropertiesBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PartOperationAttributePropertiesBuilder Class

class `NXOpen.PDM.``PartOperationAttributePropertiesBuilder`

  Bases: `NXOpen.AttributePropertiesBuilder`

  Represents an `NXOpen.PDM.PartOperationAttributePropertiesBuilder` to be used for creating attributes in part operation.

  The attribute will be distributed to all objects supplied in the selected object list.

  To create a new instance of this class, use `NXOpen.PDM.PdmSession.CreatePartOperationAttributePropertiesBuilder()`

  Default values.

  Property | Value
  --- | ---
  BooleanValue | False
  DataType | String
  IntegerValue | 0
  NumberValue | 0
  ObjectPicker (deprecated) | Object

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
ArrayIndex | Returns or sets the array index.
BooleanValue | Returns or sets the boolean value.
Category | Returns or sets the category.
DataType | Returns or sets the data type, which determines the type of attribute to be created.
DateValue | Returns the date value.
Expression | Returns or sets the expression referenced from this attribute.
IntegerValue | Returns or sets the integer value.
IsArray | Returns or sets the ‘is array’ flag is set for attributes that have more than one value.
IsReferenceType | Returns or sets the ‘is reference type’ flag is set for attributes that are linked to system expressions.
LockOnSave | Returns or sets the ‘LockOnSave’ flag is set for attributes that will be locked once the part is saved (and reloaded)
NumberValue | Returns or sets the number value.
ObjectPicker | Returns or sets the object picker.
ReferenceObject | Returns or sets the referenced logical object from this attribute.
SelectedObjects | Returns the selected object(s) list.
StringValue | Returns or sets the string value.
Tag | Returns the Tag for this object.
Title | Returns or sets the attribute title.
Units | Returns or sets the units associated with an attribute of type Number.
ValueAlias | Returns or sets the value alias.

# Methods

Method | Description
--- | ---
ApplyUnits | Apply the units currently set on the builder to any objects that have a value set for the current attribute.
Commit | Commits any edits that have been applied to the builder.
CreateAttribute | Create the attribute from the data set in the builder.
CreateOrModifyAttribute | Create the attribute from the data set in the builder.
Delete | Delete the attribute from the given object.
DeleteArray | Delete the attribute array from the given object.
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.
SetAttributeObjects | Sets the array of objects that have this attribute
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.

# Property Detail

## ReferenceObject

`PartOperationAttributePropertiesBuilder.``ReferenceObject`

  Returns or sets the referenced logical object from this attribute.

  Only used for attribute of Reference Part.

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

  Getter Method

  Signature `ReferenceObject`

  Returns: |
  Return type: | `NXOpen.PDM.LogicalObject`

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReferenceObject`

  Parameters: | referencedLogicalObject (`NXOpen.PDM.LogicalObject`) –

  New in version NX10.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

# Method Detail

## CreateOrModifyAttribute

`PartOperationAttributePropertiesBuilder.``CreateOrModifyAttribute`

  Create the attribute from the data set in the builder.

  Unlike calling commit, this method will not perform an update.

  Signature `CreateOrModifyAttribute()`

  Returns: | True if the attribute was created/edited successfully
  Return type: | bool

  New in version NX10.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

## Validate

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