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:

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	SetDestinationFilename (const char *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.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

enum NXOpen::Gateway::CopyCutBuilder::Status

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

bool NXOpen::Gateway::CopyCutBuilder::CanCopyAsSketch ( )

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

License requirements : None

NXString NXOpen::Gateway::CopyCutBuilder::DestinationFilename ( )

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

License requirements : None

NXOpen::Gateway::CopyCutBuilder::Status NXOpen::Gateway::CopyCutBuilder::GetCopyCutStatus ( )

Gets the status of copy-cut operation.

Returns: Created in NX7.5.0.

License requirements : None

std::vector<NXOpen::NXObject *> NXOpen::Gateway::CopyCutBuilder::GetNonExportableObjects ( )

Gets all non-exportable objects.

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

License requirements : None

std::vector<NXOpen::NXObject *> NXOpen::Gateway::CopyCutBuilder::GetObjects ( )

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

NXOpen::Point3d NXOpen::Gateway::CopyCutBuilder::InitialCopyLocation ( )

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

License requirements : None

bool NXOpen::Gateway::CopyCutBuilder::IsCut ( )

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

License requirements : None

void NXOpen::Gateway::CopyCutBuilder::ResetInitialCopyLocation ( )

Reset the initial copy location.

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

License requirements : None

void NXOpen::Gateway::CopyCutBuilder::SetCanCopyAsSketch ( bool canCopyAsSketch )

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

License requirements : None

Parameters

canCopyAsSketch cancopyassketch

void NXOpen::Gateway::CopyCutBuilder::SetCut ( bool isCut )

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

License requirements : None

Parameters

isCut iscut

void NXOpen::Gateway::CopyCutBuilder::SetDestinationFilename ( const NXString & filename )

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

License requirements : None

Parameters

filename filename

void NXOpen::Gateway::CopyCutBuilder::SetDestinationFilename ( const char * filename )

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

License requirements : None

Parameters

filename filename

void NXOpen::Gateway::CopyCutBuilder::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.

License requirements : None

Parameters

copyLocation Copy 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

objects All the objects to be copied or to be cut

void NXOpen::Gateway::CopyCutBuilder::SetToClipboard ( bool isToClipboard )

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

License requirements : None

Parameters

isToClipboard istoclipboard

bool NXOpen::Gateway::CopyCutBuilder::ToClipboard ( )

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:

Gateway_CopyCutBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation