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

This class provides the methods necessary to create a new part in NX Manager from an existing part. More...

Inheritance diagram for NXOpen.PDM.PartFromPartBuilder:
NXOpen.PDM.PartBuilder NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Types

enum  FileSaveAs { Some, All, None }
 This enum is used to specify which non-master parts and dependent files should be saved during the save as operation. More...
 
- Public Types inherited from NXOpen.PDM.PartBuilder
enum  Operation { ExportPartNew, AssemblyDiagram, AssemblyCreateNewComponent, Default }
 Tokens identifying every possible UG/Manager part selection dialog. More...
 

Public Member Functions

unsafe void Commit ()
 Creates the new part that has been fully-specified by calling methods on this builder. More...
 
unsafe void CreateNonmasterList ()
 Initializes the list of non-master parts that can be saved during the save as operation. More...
 
unsafe bool EditNonmasterNameToSaveAs (string oldName, string newName)
 Sets the name the non-master part will get saved as. More...
 
unsafe string[] GetNonmasterList ()
 Gets the list of non-master parts. More...
 
unsafe bool GetNonmasterToSaveAs (string partName)
 Returns whether or not the non-master part specified will actually get saved during the save as operation. More...
 
unsafe void SetNonmasterToSaveAs (string partName, bool doSaveAs)
 Sets whether or not the non-master part specified will actually get saved during the save as operation. More...
 
- Public Member Functions inherited from NXOpen.PDM.PartBuilder
unsafe string AssignPartFileName (string partFileType)
 This method generates a part file name given an input part file type and assigns this part file name to the builder. More...
 
unsafe
NXOpen.PDM.PartBuilder.PartFileNameData 
AssignPartFileName (string partNumber, string partRevision, string partFileNameType, string oldPartFileName)
 This method generates a part file name and assigns this part file name to the builder. More...
 
unsafe string AssignPartNumber (string partType)
 This method generates a part number given an input part type and assigns this part number to the builder. More...
 
unsafe
NXOpen.PDM.PartBuilder.PartNumberData 
AssignPartNumber (string oldPartNumber, string partType)
 This method generates a part number given an input part type and sets this part number to the builder. More...
 
unsafe string AssignPartRevision ()
 This method generates a part revision and assigns this part revision to the builder. More...
 
unsafe
NXOpen.PDM.PartBuilder.PartRevisionData 
AssignPartRevision (int overload)
 This method generates a part revision and sets this part revision to the builder. More...
 
unsafe
NXOpen.PDM.PartCreationObject 
CreatePartCreationObject ()
 Create an instance of a NXOpen.PDM.PartCreationObject class that acts as a proxy for a part in NX Manager mode prior to that part being created. More...
 
unsafe void CreatePartSpec (string partType, string partNumber, string partRevision, string partFileType, string partFileName)
 Create the specification for the new part that will be created. More...
 
unsafe
NXOpen.PDM.AlternateIdManager 
NewAlternateIdManager ()
 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.DatabaseAttributeManager 
NewDatabaseAttributeManager ()
 Create an instance of a NXOpen.PDM.DatabaseAttributeManager class that will be used to modify database attributes while creating the new part. More...
 
unsafe void SetAssignPartNumber (string partNumber)
 Sets the part number explicitly into builder. More...
 
unsafe void SetAssignPartType (string partType)
 Sets the part type explicitly into builder. More...
 
unsafe void SetContextOperation (NXOpen.PDM.PartBuilder.Operation operation)
 Sets explicitly the place from where part selection dialog invoked into builder. More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new 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...
 

Protected Member Functions

override void FreeResource ()
 Free resources associated with the instance. More...
 

Properties

unsafe
NXOpen.PDM.PartFromPartBuilder.FileSaveAs 
DependentFileSaveAsOption [get, set]
 Returns or sets the dependent files to save during the save as operation More...
 
unsafe
NXOpen.PDM.PartFromPartBuilder.FileSaveAs 
NonmasterSaveAsOption [get, set]
 Returns or sets the non-master parts to save during the save as operation More...
 

Detailed Description

This class provides the methods necessary to create a new part in NX Manager from an existing part.

This class is deprecated in NX10 for "Save As of master parts" operation. This class should only be used in case of Save As Non Master parts and Save As New Item Type Operations. For Save As of master parts, use NXOpen.PDM.PartOperationCopyBuilder . This class will not support Save As if there are duplicate item ids in database.

The operation that this builder supports is equivalent to the file save as operation which can:

  1. Copy a non-master dataset into a previously existing item revision,
  2. Save a master dataset (and possibly non-master datasets) into a new revision of the same item,
  3. Save any master or non-master dataset as a completely new item.

The part that is saved is always the work part. If the save is successful, then the newly saved part will be the display part.

This class is a singleton meaning only one instance of it can be exist at a time.

Created in NX4.0.0

Member Enumeration Documentation

This enum is used to specify which non-master parts and dependent files should be saved during the save as operation.

Enumerator
Some 

save selected during save as

All 

save all during save as

None 

save none during save as

Member Function Documentation

unsafe void NXOpen.PDM.PartFromPartBuilder.Commit ( )
inline

Creates the new part that has been fully-specified by calling methods on this builder.

Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As Non Master parts and Save As New Item Type Operations. For Save As of master parts, use Builder.Commit instead.

Created in NX4.0.0

License requirements: None.

unsafe void NXOpen.PDM.PartFromPartBuilder.CreateNonmasterList ( )
inline

Initializes the list of non-master parts that can be saved during the save as operation.

Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use NXOpen.PDM.PartOperationCopyBuilder.CreateNonMasterListForCopyLogicalObject .

Created in NX4.0.0

License requirements: None.

unsafe bool NXOpen.PDM.PartFromPartBuilder.EditNonmasterNameToSaveAs ( 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.

Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use NXOpen.PDM.PartOperationCopyBuilder.EditNonMasterToCopyName .

Created in NX4.0.0

License requirements: None.

Parameters
oldNamethe non-master part whose save as name is being set here
newNamethe new name
Returns
Whether or not the name is a valid data set name. The name will get set on the builder no matter if it is valid or not.
override void NXOpen.PDM.PartFromPartBuilder.FreeResource ( )
inlineprotectedvirtual

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Created in NX4.0.0

License requirements: None.

Reimplemented from NXOpen.PDM.PartBuilder.

unsafe string [] NXOpen.PDM.PartFromPartBuilder.GetNonmasterList ( )
inline

Gets the list of non-master parts.

Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use NXOpen.PDM.PartOperationCopyBuilder.GetNonMasterListForCopyLogicalObject .

Created in NX8.5.0

License requirements: None.

Returns
Non-master part file names
unsafe bool NXOpen.PDM.PartFromPartBuilder.GetNonmasterToSaveAs ( string  partName)
inline

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

Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use NXOpen.PDM.PartOperationCopyBuilder.IsNonMasterForLogicalObjectBeingCopied .

Created in NX4.0.0

License requirements: None.

Parameters
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.PartFromPartBuilder.SetNonmasterToSaveAs ( string  partName,
bool  doSaveAs 
)
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.

Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use NXOpen.PDM.PartOperationCopyBuilder.SetSelectedNonMasterToCopy .

Created in NX4.0.0

License requirements: None.

Parameters
partNamethe non-master part whose save option is being set here
doSaveAsTrue means that this non-master part will be saved. False means that this non-master part will not be saved.

Property Documentation

unsafe NXOpen.PDM.PartFromPartBuilder.FileSaveAs NXOpen.PDM.PartFromPartBuilder.DependentFileSaveAsOption
getset

Returns or sets the dependent files to save during the save as operation

Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use NXOpen.PDM.PartOperationCopyBuilder.DependentFilesToCopyOption .

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PDM.PartFromPartBuilder.FileSaveAs NXOpen.PDM.PartFromPartBuilder.NonmasterSaveAsOption
getset

Returns or sets the non-master parts to save during the save as operation

Deprecated in NX10 for "Save As of master parts" operation. This should only be used in case of Save As New Item Type Operations. For Save As of master parts, use NXOpen.PDM.PartOperationCopyBuilder.GetCopyNonMasterPartsOption .

Created in NX4.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.