CopyPasteBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CopyPasteBuilder Class

class `NXOpen.Features.``CopyPasteBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Features.CopyPasteBuilder`

  To create a new instance of this class, use `NXOpen.Features.FeatureCollection.CreateCopyPasteBuilder2()`

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
Associative | Returns or sets the associative toggle
CopyResolveGeometry | Returns or sets the copy resolving geometry toggle
ExpressionOption | Returns or sets the expression option
ParentOption | Returns or sets the parent option
SelectOption | Returns or sets the parent select option.
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.
GetBuilderVersion | The builder version getting function
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetFeatureReferences | Returns the feature references builder
GetObject | Returns the object currently being edited by this builder.
SetBuilderVersion | The builder version setting function.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateBuilder | The update builder function, needs to be called after parent select option is reset
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

CopyPasteBuilderBuilderVersion Enumeration | Types of version number
CopyPasteBuilderExpressionTransferOption Enumeration | Types of expression transfer mode
CopyPasteBuilderParentSelectOption Enumeration | Types of parent select option; Specifying smart object or selecting input for original parent
CopyPasteBuilderParentTransferOption Enumeration | Types of parent transfer mode

# Property Detail

## Associative

`CopyPasteBuilder.``Associative`

  Returns or sets the associative toggle

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

  Getter Method

  Signature `Associative`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Associative`

  Parameters: | associative (bool) –

  New in version NX8.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## CopyResolveGeometry

`CopyPasteBuilder.``CopyResolveGeometry`

  Returns or sets the copy resolving geometry toggle

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

  Getter Method

  Signature `CopyResolveGeometry`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CopyResolveGeometry`

  Parameters: | copyResolveGeometry (bool) –

  New in version NX8.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ExpressionOption

`CopyPasteBuilder.``ExpressionOption`

  Returns or sets the expression option

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

  Getter Method

  Signature `ExpressionOption`

  Returns: |
  Return type: | `NXOpen.Features.CopyPasteBuilderExpressionTransferOption`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ExpressionOption`

  Parameters: | expressionOption (`NXOpen.Features.CopyPasteBuilderExpressionTransferOption`) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ParentOption

`CopyPasteBuilder.``ParentOption`

  Returns or sets the parent option

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

  Getter Method

  Signature `ParentOption`

  Returns: |
  Return type: | `NXOpen.Features.CopyPasteBuilderParentTransferOption`

  New in version NX6.0.0.

  Deprecated since version NX8.0.0: This functionality is no longer supported.

  License requirements: None.

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

  Setter Method

  Signature `ParentOption`

  Parameters: | parentOption (`NXOpen.Features.CopyPasteBuilderParentTransferOption`) –

  New in version NX6.0.0.

  Deprecated since version NX8.0.0: This functionality is no longer supported.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SelectOption

`CopyPasteBuilder.``SelectOption`

  Returns or sets the parent select option.

  This option allows the user to control if the input smart objects for the copied feature should have all the input smart object creation methods available from the parent feature or only use the smart object creation method selected on the original parent

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

  Getter Method

  Signature `SelectOption`

  Returns: |
  Return type: | `NXOpen.Features.CopyPasteBuilderParentSelectOption`

  New in version NX8.5.1.

  License requirements: None.

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

  Setter Method

  Signature `SelectOption`

  Parameters: | selectionOption (`NXOpen.Features.CopyPasteBuilderParentSelectOption`) –

  New in version NX8.5.1.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## GetBuilderVersion

`CopyPasteBuilder.``GetBuilderVersion`

  The builder version getting function

  Signature `GetBuilderVersion()`

  Returns: |
  Return type: | `NXOpen.Features.CopyPasteBuilderBuilderVersion`

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## GetFeatureReferences

`CopyPasteBuilder.``GetFeatureReferences`

  Returns the feature references builder

  Signature `GetFeatureReferences()`

  Returns: |
  Return type: | `NXOpen.Features.FeatureReferencesBuilder`

  New in version NX6.0.0.

  License requirements: None.

## SetBuilderVersion

`CopyPasteBuilder.``SetBuilderVersion`

  The builder version setting function.

  This function sets builder version number with value which is treated as bit field. It still uses the enumeration defined in previous releases. In order to set the builder version number to the correct value, the version number could be calculated by a bitwise or operation on previous releases versions number, or by an addition of previous releases versions number.

  Signature `SetBuilderVersion(version)`

  Parameters: | version (`NXOpen.Features.CopyPasteBuilderBuilderVersion`) –

  New in version NX8.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## UpdateBuilder

`CopyPasteBuilder.``UpdateBuilder`

  The update builder function, needs to be called after parent select option is reset

  Signature `UpdateBuilder()`

  New in version NX8.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Validate

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