CopyCutBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CopyCutBuilder Class

class `NXOpen.Gateway.``CopyCutBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Gateway.CopyCutBuilder`

  To create a new instance of this class, use `NXOpen.ClipboardOperationsManager.CreateCopyCutBuilder()`

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
CanCopyAsSketch | Returns or sets a flag indicating whether to copy as sketch curves or not
DestinationFilename | Returns or sets the string of the filename to which to copy or cut the objects to
InitialCopyLocation | Returns or sets the initial copy location mainly used to define default copy location of sketch objects
IsCut | Returns or sets a flag indicating whether it is a copy or cut operation
Tag | Returns the Tag for this object.
ToClipboard | Returns or sets a flag indicating whether copy cut to clipboard or copy cut to a file

# 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.
GetCopyCutStatus | Gets the status of copy-cut operation
GetNonExportableObjects | Gets all non-exportable objects
GetObject | Returns the object currently being edited by this builder.
GetObjects | Gets all objects to be copied or to be cut
ResetInitialCopyLocation | Reset the initial copy location.
SetObjects | Sets all objects to be copied or to be cut
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

CopyCutBuilderStatus Enumeration | Status of Copy or Cut Operation

# Property Detail

## CanCopyAsSketch

`CopyCutBuilder.``CanCopyAsSketch`

  Returns or sets a flag indicating whether to copy as sketch curves or not

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

  Getter Method

  Signature `CanCopyAsSketch`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CanCopyAsSketch`

  Parameters: | canCopyAsSketch (bool) –

  New in version NX7.5.0.

  License requirements: None.

## DestinationFilename

`CopyCutBuilder.``DestinationFilename`

  Returns or sets the string of the filename to which to copy or cut the objects to

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

  Getter Method

  Signature `DestinationFilename`

  Returns: |
  Return type: | str

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DestinationFilename`

  Parameters: | filename (str) –

  New in version NX7.5.0.

  License requirements: None.

## InitialCopyLocation

`CopyCutBuilder.``InitialCopyLocation`

  Returns or sets the initial copy location mainly used to define default copy location of sketch objects

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

  Getter Method

  Signature `InitialCopyLocation`

  Returns: | Copy location in absolute coordinates
  Return type: | `NXOpen.Point3d`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `InitialCopyLocation`

  Parameters: | copyLocation (`NXOpen.Point3d`) – Copy location in absolute coordinates

  New in version NX7.5.0.

  License requirements: None.

## IsCut

`CopyCutBuilder.``IsCut`

  Returns or sets a flag indicating whether it is a copy or cut operation

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

  Getter Method

  Signature `IsCut`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `IsCut`

  Parameters: | isCut (bool) –

  New in version NX7.5.0.

  License requirements: None.

## ToClipboard

`CopyCutBuilder.``ToClipboard`

  Returns or sets a flag indicating whether copy cut to clipboard or copy cut to a file

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

  Getter Method

  Signature `ToClipboard`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ToClipboard`

  Parameters: | isToClipboard (bool) –

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## GetCopyCutStatus

`CopyCutBuilder.``GetCopyCutStatus`

  Gets the status of copy-cut operation

  Signature `GetCopyCutStatus()`

  Returns: |
  Return type: | `NXOpen.Gateway.CopyCutBuilderStatus`

  New in version NX7.5.0.

  License requirements: None.

## GetNonExportableObjects

`CopyCutBuilder.``GetNonExportableObjects`

  Gets all non-exportable objects

  Signature `GetNonExportableObjects()`

  Returns: | All the non-exportable objects
  Return type: | list of `NXOpen.NXObject`

  New in version NX7.5.0.

  License requirements: None.

## GetObjects

`CopyCutBuilder.``GetObjects`

  Gets all objects to be copied or to be cut

  Signature `GetObjects()`

  Returns: | All the objects to be copied or to be cut
  Return type: | list of `NXOpen.NXObject`

  New in version NX7.5.0.

  License requirements: None.

## ResetInitialCopyLocation

`CopyCutBuilder.``ResetInitialCopyLocation`

  Reset the initial copy location.

  After this previously set initial copy location will not be used

  Signature `ResetInitialCopyLocation()`

  New in version NX7.5.0.

  License requirements: None.

## SetObjects

`CopyCutBuilder.``SetObjects`

  Sets all objects to be copied or to be cut

  Signature `SetObjects(objects)`

  Parameters: | objects (list of `NXOpen.NXObject`) – All the objects to be copied or to be cut

  New in version NX7.5.0.

  License requirements: None.

## Validate

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