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

Represents a builder class that performs various Save As operations. More...

Inheritance diagram for NXOpen.PDM.PartOperationCopyBuilder:
NXOpen.PDM.PartOperationBuilder NXOpen.Builder NXOpen.IAttributeSourceObjectBuilder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink NXOpen.PDM.PartOperationMakeUniqueBuilder

Public Types

enum  CopyDependentFiles { All, None }
 This enum is used to specify which dependent files should be copied to new part during the save as operation. More...
 
enum  CopyNonMasterParts { All, None }
 This enum is used to specify which non-master parts should be copied to new part during the save as operation. More...
 
enum  OperationSubType { Default, MakeUnique }
 Represents an operation sub type for copying a part More...
 
- Public Types inherited from NXOpen.PDM.PartOperationBuilder
enum  DependentFileSaveAs { All, None }
 This enum is used to specify which dependent files should be saved during the save as operation. More...
 
enum  NonMasterSaveAs { All, None }
 This enum is used to specify which non-master parts should be saved during the save as operation. More...
 
enum  OperationType { SaveAs, Revise, Create, Import }
 Represents an operation type that can be performed on a part More...
 

Public Member Functions

unsafe void AddRelatedPartsToCopy (NXOpen.BasePart basePart, NXOpen.BasePart[] relatedParts, string[] relatedPartsReasons, NXOpen.PDM.PartOperationBuilder.OperationType operation)
 Add related part to the part undergoing an operation. More...
 
unsafe void CreateNonMasterListForCopyLogicalObject (NXOpen.PDM.LogicalObject logicalObject)
 Create NonMaster list for the selected logical Object More...
 
unsafe bool EditNonMasterToCopyName (NXOpen.PDM.LogicalObject logicalObject, string oldName, string newName)
 Sets the name the non-master part will get saved as. More...
 
unsafe
NXOpen.PDM.PartOperationCopyBuilder.CopyNonMasterParts 
GetCopyNonMasterPartsOption (NXOpen.PDM.LogicalObject logicalObject)
 Get the nonmasters saveAs option for given logical object. More...
 
unsafe string[] GetNonMasterListForCopyLogicalObject (NXOpen.PDM.LogicalObject logicalObject)
 Gets NonMaster list for the given logical Object More...
 
unsafe
NXOpen.PDM.PartOperationCopyBuilder.OperationSubType 
GetOperationSubType ()
 Returns the NXOpen.PDM.PartOperationCopyBuilder.OperationSubType for Create. More...
 
unsafe NXOpen.Part GetSourcePartFromLogicalObject (NXOpen.PDM.LogicalObject logicalObject)
 Returns the source part of this logical object. More...
 
unsafe bool IsNonMasterForLogicalObjectBeingCopied (NXOpen.PDM.LogicalObject logicalObject, string partName)
 Returns whether or not the non-master part specified for the given NXOpen.PDM.LogicalObject will actually get saved during the save as operation. More...
 
unsafe void SetCopyNonMasterPartsOption (NXOpen.PDM.LogicalObject logicalObject, NXOpen.PDM.PartOperationCopyBuilder.CopyNonMasterParts saveOption)
 Set the nonmasters saveAs option for given logical object. More...
 
unsafe void SetOperationSubType (NXOpen.PDM.PartOperationCopyBuilder.OperationSubType operationSubType)
 Sets the NXOpen.PDM.PartOperationCopyBuilder.OperationSubType for Create. More...
 
unsafe void SetSelectedNonMasterToCopy (NXOpen.PDM.LogicalObject logicalObject, string partName)
 Sets whether or not the non-master part specified will actually get saved during the save as operation. More...
 
unsafe void SetSelectedPartsToCopy (NXOpen.BasePart[] selectedParts, out NXOpen.BasePart[] failedParts)
 Sets the selected parts. More...
 
- Public Member Functions inherited from NXOpen.PDM.PartOperationBuilder
unsafe void AddRelatedPartToOperate (NXOpen.BasePart basePart, NXOpen.BasePart[] relatedParts, string[] relatedPartsReasons, NXOpen.PDM.PartOperationBuilder.OperationType operation)
 Add related part to the part undergoing an operation. More...
 
unsafe NXOpen.ErrorList AutoAssignAttributes (NXOpen.NXObject[] objects)
 Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign. More...
 
unsafe NXOpen.ErrorList AutoAssignAttributesWithNamingPattern (NXOpen.NXObject[] objects, NXOpen.NXObject[] properties)
 Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign. More...
 
unsafe void ClearWarnings ()
 Executes method ClearWarningCodeToLogicalObjectsSetMap() which clears m_warningCodeToLogicalObjectsSetMap More...
 
unsafe NXOpen.NXObject CreateAttributeTitleToNamingPatternMap (string[] attributeTitles, string[] titlePatterns)
 Creates a map object of attribute titles to their corresponding naming pattern More...
 
unsafe void CreateLogicalObjects (out NXOpen.PDM.LogicalObject[] logicalObjects)
 Creates the pre-creation objects for the parts More...
 
unsafe void CreateNonMasterListForLogicalObject (NXOpen.PDM.LogicalObject logicalObject)
 Create NonMaster list for the selected logical Object More...
 
unsafe void CreateSpecificationsForLogicalObjects (NXOpen.PDM.LogicalObject[] logicalObjects)
 Create new specifications for Logical Objects More...
 
unsafe bool EditNonMasterName (NXOpen.PDM.LogicalObject logicalObject, string oldName, string newName)
 Sets the name the non-master part will get saved as. More...
 
unsafe
NXOpen.PDM.AlternateIdManager 
GetAlternateIDManager (NXOpen.PDM.LogicalObject logicalObject)
 Create an instance of a NXOpen.PDM.AlternateIdManager class that will be used to create alternate ID information while creating the new part. More...
 
unsafe
NXOpen.PDM.PartOperationBuilder.OperationType 
GetDialogOperation ()
 Returns the dialog operation Applicable only for operation types PartOperationBuilder.OperationType.SaveAs and PartOperationBuilder.OperationType.Revise More...
 
unsafe
NXOpen.PDM.ErrorMessageHandler 
GetErrorMessageHandler (bool refresh)
 Returns ErrorMessageHandler More...
 
unsafe
NXOpen.PDM.PartOperationBuilder.NonMasterSaveAs 
GetNonMasterCopyOption (NXOpen.PDM.LogicalObject logicalObject)
 Get the nonmasters saveAs option for given logical object. More...
 
unsafe string[] GetNonMasterList (NXOpen.PDM.LogicalObject logicalObject)
 Gets NonMaster list for the given logical Object More...
 
unsafe NXOpen.ErrorList GetOperationFailures ()
 Returns part operation failures More...
 
unsafe bool IsNonMasterBeingCopied (NXOpen.PDM.LogicalObject logicalObject, string partName)
 Returns whether or not the non master part specified for the given NXOpen.PDM.LogicalObject will actually get saved during the save as operation. More...
 
unsafe void SetDialogOperation (NXOpen.PDM.PartOperationBuilder.OperationType dialogOperation)
 Sets the dialog operation. More...
 
unsafe void SetNonMasterSaveAsOption (NXOpen.PDM.LogicalObject logicalObject, NXOpen.PDM.PartOperationBuilder.NonMasterSaveAs saveOption)
 Set the nonmasters saveAs option for given logical object More...
 
unsafe void SetSelectedNonMasterToSaveAs (NXOpen.PDM.LogicalObject logicalObject, string partName)
 Sets whether or not the non-master part specified will actually get saved during the save as operation. More...
 
unsafe void SetSelectedParts (NXOpen.BasePart[] selectedParts, out NXOpen.BasePart[] failedParts)
 Sets the selected parts. More...
 
unsafe void ValidateLogicalObjectsToCommit ()
 Validates NXOpen.PDM.LogicalObject objects with this builder and udpates the operation failuers. 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
NXOpen.PDM.PartOperationCopyBuilder.CopyDependentFiles 
DependentFilesToCopyOption [get, set]
 Returns or sets the Dependent files Save As option. More...
 
unsafe bool ReplaceAllComponentsInSession [get, set]
 Returns or sets the replace all components. More...
 
- Properties inherited from NXOpen.PDM.PartOperationBuilder
unsafe string DefaultDestinationFolder [get, set]
 Returns or sets the default destination folder string for the part being created . More...
 
unsafe
NXOpen.PDM.PartOperationBuilder.DependentFileSaveAs 
DependentFileSaveAsOption [get, set]
 Returns or sets the Dependent files Save As option. More...
 
unsafe bool ReplaceAllComponents [get, set]
 Returns or sets the replace all components. 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 builder class that performs various Save As operations.

To create a new instance of this class, use NXOpen.PDM.PdmSession.CreateCopyOperationBuilder

Created in NX10.0.0

Member Enumeration Documentation

This enum is used to specify which dependent files should be copied to new part during the save as operation.

Enumerator
All 

save all during save as

None 

save none during save as

This enum is used to specify which non-master parts should be copied to new part during the save as operation.

Enumerator
All 

save all during save as

None 

save none during save as

Represents an operation sub type for copying a part

Enumerator
Default 

Save As dialog

MakeUnique 

MakeUnique flavour of Save As dialog

Member Function Documentation

unsafe void NXOpen.PDM.PartOperationCopyBuilder.AddRelatedPartsToCopy ( NXOpen.BasePart  basePart,
NXOpen.BasePart[]  relatedParts,
string[]  relatedPartsReasons,
NXOpen.PDM.PartOperationBuilder.OperationType  operation 
)
inline

Add related part to the part undergoing an operation.

Example: if user selects a part for Save As which has Linked Part Modules that should also undergo Save As, they should be added as related parts. Applicable only for operation types PartOperationBuilder.OperationType.SaveAs and PartOperationBuilder.OperationType.Revise

Created in NX10.0.0

License requirements: None.

Parameters
basePart
relatedParts
relatedPartsReasons
operation
unsafe void NXOpen.PDM.PartOperationCopyBuilder.CreateNonMasterListForCopyLogicalObject ( NXOpen.PDM.LogicalObject  logicalObject)
inline

Create NonMaster list for the selected logical Object

Created in NX10.0.0

Deprecated in NX11.0.0. Use NXOpen.PDM.NonMasterData.CreateNonMasterListForLogicalObject instead

License requirements: None.

Parameters
logicalObject
unsafe bool NXOpen.PDM.PartOperationCopyBuilder.EditNonMasterToCopyName ( NXOpen.PDM.LogicalObject  logicalObject,
string  oldName,
string  newName 
)
inline

Sets the name the non-master part will get saved as.

It will get saved as the original non-master name if this method is not called.

Created in NX10.0.0

Deprecated in NX11.0.0. Use NXOpen.PDM.NonMasterData.EditNonMasterToCopyName instead

License requirements: None.

Parameters
logicalObject
oldNamethe non-master part whose save as name is being set here
newNamethe new name
Returns
flag to indicate whether the newName is valid
unsafe NXOpen.PDM.PartOperationCopyBuilder.CopyNonMasterParts NXOpen.PDM.PartOperationCopyBuilder.GetCopyNonMasterPartsOption ( NXOpen.PDM.LogicalObject  logicalObject)
inline

Get the nonmasters saveAs option for given logical object.

Save As option can be one of these PartOperationCopyBuilder.CopyNonMasterParts.All and PartOperationCopyBuilder.CopyNonMasterParts.None

Created in NX10.0.0

Deprecated in NX11.0.0. Use NXOpen.PDM.NonMasterData.GetCopyNonMasterPartsOption instead

License requirements: None.

Parameters
logicalObject
Returns
unsafe string [] NXOpen.PDM.PartOperationCopyBuilder.GetNonMasterListForCopyLogicalObject ( NXOpen.PDM.LogicalObject  logicalObject)
inline

Gets NonMaster list for the given logical Object

Created in NX10.0.0

Deprecated in NX11.0.0. Use NXOpen.PDM.NonMasterData.GetNonMasterListForCopyLogicalObject instead

License requirements: None.

Parameters
logicalObject
Returns
Non-master part file names
unsafe NXOpen.PDM.PartOperationCopyBuilder.OperationSubType NXOpen.PDM.PartOperationCopyBuilder.GetOperationSubType ( )
inline

Returns the NXOpen.PDM.PartOperationCopyBuilder.OperationSubType for Create.

Created in NX10.0.0

License requirements: None.

Returns
unsafe NXOpen.Part NXOpen.PDM.PartOperationCopyBuilder.GetSourcePartFromLogicalObject ( NXOpen.PDM.LogicalObject  logicalObject)
inline

Returns the source part of this logical object.

Created in NX12.0.1

License requirements: None.

Parameters
logicalObject
Returns
unsafe bool NXOpen.PDM.PartOperationCopyBuilder.IsNonMasterForLogicalObjectBeingCopied ( NXOpen.PDM.LogicalObject  logicalObject,
string  partName 
)
inline

Returns whether or not the non-master part specified for the given NXOpen.PDM.LogicalObject will actually get saved during the save as operation.

Created in NX10.0.0

Deprecated in NX11.0.0. Use NXOpen.PDM.NonMasterData.IsNonMasterForLogicalObjectBeingCopied instead

License requirements: None.

Parameters
logicalObject
partNamethe non-master part that the caller wants to save or not save
Returns
True means that this non-master will be saved. False means that this non-master will not be saved.
unsafe void NXOpen.PDM.PartOperationCopyBuilder.SetCopyNonMasterPartsOption ( NXOpen.PDM.LogicalObject  logicalObject,
NXOpen.PDM.PartOperationCopyBuilder.CopyNonMasterParts  saveOption 
)
inline

Set the nonmasters saveAs option for given logical object.

Save As option can be one of these PartOperationCopyBuilder.CopyNonMasterParts.All and PartOperationCopyBuilder.CopyNonMasterParts.None

Created in NX10.0.0

Deprecated in NX11.0.0. Use NXOpen.PDM.NonMasterData.SetNonMasterSaveAsOption instead

License requirements: None.

Parameters
logicalObject
saveOption
unsafe void NXOpen.PDM.PartOperationCopyBuilder.SetOperationSubType ( NXOpen.PDM.PartOperationCopyBuilder.OperationSubType  operationSubType)
inline

Sets the NXOpen.PDM.PartOperationCopyBuilder.OperationSubType for Create.

Created in NX10.0.0

License requirements: None.

Parameters
operationSubType
unsafe void NXOpen.PDM.PartOperationCopyBuilder.SetSelectedNonMasterToCopy ( NXOpen.PDM.LogicalObject  logicalObject,
string  partName 
)
inline

Sets whether or not the non-master part specified will actually get saved during the save as operation.

True means that it will be saved. False means that it will not be saved.

Created in NX10.0.0

Deprecated in NX11.0.0. Use NXOpen.PDM.NonMasterData.SetSelectedNonMasterToCopy instead

License requirements: None.

Parameters
logicalObject
partNamethe non-master part whose save option is being set here
unsafe void NXOpen.PDM.PartOperationCopyBuilder.SetSelectedPartsToCopy ( NXOpen.BasePart[]  selectedParts,
out NXOpen.BasePart[]  failedParts 
)
inline

Sets the selected parts.

Applicable only for operation types PartOperationBuilder.OperationType.SaveAs and PartOperationBuilder.OperationType.Revise Also returns an array of parts failed to added, these are not removed from the input array though. NXOpen.PDM.PartOperationBuilder.GetOperationFailures can be called to get the errors occurred during this operation.

Created in NX10.0.0

License requirements: None.

Parameters
selectedParts
failedParts

Property Documentation

unsafe NXOpen.PDM.PartOperationCopyBuilder.CopyDependentFiles NXOpen.PDM.PartOperationCopyBuilder.DependentFilesToCopyOption
getset

Returns or sets the Dependent files Save As option.

Save As option can be one of these PartOperationCopyBuilder.CopyDependentFiles.All and PartOperationCopyBuilder.CopyDependentFiles.None

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PDM.PartOperationCopyBuilder.ReplaceAllComponentsInSession
getset

Returns or sets the replace all components.

This option specifies whether part will be replaced or copied. Applicable only for operation types PartOperationBuilder.OperationType.SaveAs and PartOperationBuilder.OperationType.Revise

Created in NX10.0.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.