NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Gateway.CopyCutBuilder Class Reference

Represents a NXOpen.Gateway.CopyCutBuilder More...

Inheritance diagram for NXOpen.Gateway.CopyCutBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  Status {
  NoObjectsCopied, NonExportableObjects, PartExportFailed, ErrorDuringCut,
  AllObjectsCopied
}
 Status of Copy or Cut Operation More...
 

Public Member Functions

unsafe
NXOpen.Gateway.CopyCutBuilder.Status 
GetCopyCutStatus ()
 Gets the status of copy-cut operation More...
 
unsafe NXOpen.NXObject[] GetNonExportableObjects ()
 Gets all non-exportable objects More...
 
unsafe NXOpen.NXObject[] GetObjects ()
 Gets all objects to be copied or to be cut More...
 
unsafe void ResetInitialCopyLocation ()
 Reset the initial copy location. More...
 
unsafe void SetObjects (NXOpen.NXObject[] objects)
 Sets all objects to be copied or to be cut More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe bool CanCopyAsSketch [get, set]
 Returns or sets a flag indicating whether to copy as sketch curves or not More...
 
unsafe string DestinationFilename [get, set]
 Returns or sets the string of the filename to which to copy or cut the objects to More...
 
unsafe NXOpen.Point3d InitialCopyLocation [get, set]
 Returns or sets the initial copy location mainly used to define default copy location of sketch objects More...
 
unsafe bool IsCut [get, set]
 Returns or sets a flag indicating whether it is a copy or cut operation More...
 
unsafe bool ToClipboard [get, set]
 Returns or sets a flag indicating whether copy cut to clipboard or copy cut to a file More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Gateway.CopyCutBuilder

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

Created in NX7.5.0

Member Enumeration Documentation

Status of Copy or Cut Operation

Enumerator
NoObjectsCopied 

No objects were successfully copied

NonExportableObjects 

Certain non-exportable objects were not copied

PartExportFailed 

Error while exporting part with copied/cut objects

ErrorDuringCut 

Error during the cut operation

AllObjectsCopied 

All objects were successfully copied

Member Function Documentation

unsafe NXOpen.Gateway.CopyCutBuilder.Status NXOpen.Gateway.CopyCutBuilder.GetCopyCutStatus ( )
inline

Gets the status of copy-cut operation

Created in NX7.5.0

License requirements: None.

Returns
unsafe NXOpen.NXObject [] NXOpen.Gateway.CopyCutBuilder.GetNonExportableObjects ( )
inline

Gets all non-exportable objects

Created in NX7.5.0

License requirements: None.

Returns
All the non-exportable objects
unsafe NXOpen.NXObject [] NXOpen.Gateway.CopyCutBuilder.GetObjects ( )
inline

Gets all objects to be copied or to be cut

Created in NX7.5.0

License requirements: None.

Returns
All the objects to be copied or to be cut
unsafe void NXOpen.Gateway.CopyCutBuilder.ResetInitialCopyLocation ( )
inline

Reset the initial copy location.

After this previously set initial copy location will not be used

Created in NX7.5.0

License requirements: None.

unsafe void NXOpen.Gateway.CopyCutBuilder.SetObjects ( NXOpen.NXObject[]  objects)
inline

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

Property Documentation

unsafe bool NXOpen.Gateway.CopyCutBuilder.CanCopyAsSketch
getset

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Gateway.CopyCutBuilder.DestinationFilename
getset

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point3d NXOpen.Gateway.CopyCutBuilder.InitialCopyLocation
getset

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Gateway.CopyCutBuilder.IsCut
getset

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Gateway.CopyCutBuilder.ToClipboard
getset

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

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.


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