NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Gateway::CopyCutBuilder Class Reference

Represents a Gateway::CopyCutBuilder
To create a new instance of this class, use ClipboardOperationsManager::CreateCopyCutBuilder

Created in NX7.5.0. More...

Inheritance diagram for NXOpen::Gateway::CopyCutBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  Status {
  StatusNoObjectsCopied, StatusNonExportableObjects, StatusPartExportFailed, StatusErrorDuringCut,
  StatusAllObjectsCopied
}
 Status of Copy or Cut Operation. More...

Public Member Functions

bool CanCopyAsSketch ()
 Returns a flag indicating whether to copy as sketch curves or not
Created in NX7.5.0.
NXString DestinationFilename ()
 Returns the string of the filename to which to copy or cut the objects to
Created in NX7.5.0.
NXOpen::Gateway::CopyCutBuilder::Status GetCopyCutStatus ()
 Gets the status of copy-cut operation.
std::vector< NXOpen::NXObject * > GetNonExportableObjects ()
 Gets all non-exportable objects.
std::vector< NXOpen::NXObject * > GetObjects ()
 Gets all objects to be copied or to be cut.
NXOpen::Point3d InitialCopyLocation ()
 Returns the initial copy location mainly used to define default copy location of sketch objects
Created in NX7.5.0.
bool IsCut ()
 Returns a flag indicating whether it is a copy or cut operation
Created in NX7.5.0.
void ResetInitialCopyLocation ()
 Reset the initial copy location.
void SetCanCopyAsSketch (bool canCopyAsSketch)
 Sets a flag indicating whether to copy as sketch curves or not
Created in NX7.5.0.
void SetCut (bool isCut)
 Sets a flag indicating whether it is a copy or cut operation
Created in NX7.5.0.
void SetDestinationFilename (const NXString &filename)
 Sets the string of the filename to which to copy or cut the objects to
Created in NX7.5.0.
void SetInitialCopyLocation (const NXOpen::Point3d &copyLocation)
 Sets the initial copy location mainly used to define default copy location of sketch objects
Created in NX7.5.0.
void SetObjects (const std::vector< NXOpen::NXObject * > &objects)
 Sets all objects to be copied or to be cut
Created in NX7.5.0.
void SetToClipboard (bool isToClipboard)
 Sets a flag indicating whether copy cut to clipboard or copy cut to a file
Created in NX7.5.0.
bool ToClipboard ()
 Returns a flag indicating whether copy cut to clipboard or copy cut to a file
Created in NX7.5.0.

Detailed Description

Represents a Gateway::CopyCutBuilder
To create a new instance of this class, use ClipboardOperationsManager::CreateCopyCutBuilder

Created in NX7.5.0.



Member Enumeration Documentation

Status of Copy or Cut Operation.

Enumerator:
StatusNoObjectsCopied 

No objects were successfully copied.

StatusNonExportableObjects 

Certain non-exportable objects were not copied.

StatusPartExportFailed 

Error while exporting part with copied/cut objects.

StatusErrorDuringCut 

Error during the cut operation.

StatusAllObjectsCopied 

All objects were successfully copied.


Member Function Documentation

Returns a flag indicating whether to copy as sketch curves or not
Created in NX7.5.0.



License requirements : None

Returns the string of the filename to which to copy or cut the objects to
Created in NX7.5.0.



License requirements : None

Gets the status of copy-cut operation.

Returns:

Created in NX7.5.0.

License requirements : None

Gets all non-exportable objects.

Returns:
All the non-exportable objects
Created in NX7.5.0.

License requirements : None

Gets all objects to be copied or to be cut.

Returns:
All the objects to be copied or to be cut
Created in NX7.5.0.

License requirements : None

Returns the initial copy location mainly used to define default copy location of sketch objects
Created in NX7.5.0.



License requirements : None

Returns a flag indicating whether it is a copy or cut operation
Created in NX7.5.0.



License requirements : None

Reset the initial copy location.

After this previously set initial copy location will not be used
Created in NX7.5.0.

License requirements : None

Sets a flag indicating whether to copy as sketch curves or not
Created in NX7.5.0.



License requirements : None

Parameters:
canCopyAsSketchcancopyassketch

Sets a flag indicating whether it is a copy or cut operation
Created in NX7.5.0.



License requirements : None

Parameters:
isCutiscut

Sets the string of the filename to which to copy or cut the objects to
Created in NX7.5.0.



License requirements : None

Parameters:
filenamefilename

Sets the initial copy location mainly used to define default copy location of sketch objects
Created in NX7.5.0.



License requirements : None

Parameters:
copyLocationCopy location in absolute coordinates
void NXOpen::Gateway::CopyCutBuilder::SetObjects ( const std::vector< NXOpen::NXObject * > &  objects)

Sets all objects to be copied or to be cut
Created in NX7.5.0.



License requirements : None

Parameters:
objectsAll the objects to be copied or to be cut

Sets a flag indicating whether copy cut to clipboard or copy cut to a file
Created in NX7.5.0.



License requirements : None

Parameters:
isToClipboardistoclipboard

Returns a flag indicating whether copy cut to clipboard or copy cut to a file
Created in NX7.5.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.