Represents a builder class that performs various design element operations. More...

Inheritance diagram for NXOpen.PDM.PartOperationBuilder:

Public Types
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	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 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 design element operations.

The operation can be one of NXOpen.PDM.PartOperationBuilder.OperationType

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

Created in NX9.0.0

Member Enumeration Documentation

enum NXOpen.PDM.PartOperationBuilder.DependentFileSaveAs

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

Enumerator
All	save all during save as
None	save none during save as

enum NXOpen.PDM.PartOperationBuilder.NonMasterSaveAs

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

Enumerator
All	save all during save as
None	save none during save as

enum NXOpen.PDM.PartOperationBuilder.OperationType

Represents an operation type that can be performed on a part

Enumerator
SaveAs	Save As Part
Revise	Revise Part
Create	Create Part
Import	Import Part

Member Function Documentation

unsafe void NXOpen.PDM.PartOperationBuilder.AddRelatedPartToOperate	(	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 NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCopyBuilder.AddRelatedPartsToCopy instead

License requirements: None.

Parameters

basePart
relatedParts
relatedPartsReasons
operation

unsafe NXOpen.ErrorList NXOpen.PDM.PartOperationBuilder.AutoAssignAttributes ( NXOpen.NXObject[] objects )

inline

Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.

Created in NX8.5.0

License requirements: None.

Parameters

objects

Returns

Implements NXOpen.IAttributeSourceObjectBuilder.

unsafe NXOpen.ErrorList NXOpen.PDM.PartOperationBuilder.AutoAssignAttributesWithNamingPattern	(	NXOpen.NXObject[]	objects,
		NXOpen.NXObject[]	properties
	)

inline

Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.

properties needs to be created using CreateAttributeTitleToNamingPatternMap

Created in NX12.0.0

License requirements: None.

Parameters

objects
properties

Returns

Implements NXOpen.IAttributeSourceObjectBuilder.

unsafe void NXOpen.PDM.PartOperationBuilder.ClearWarnings ( )

inline

Executes method ClearWarningCodeToLogicalObjectsSetMap() which clears m_warningCodeToLogicalObjectsSetMap

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.NXObject NXOpen.PDM.PartOperationBuilder.CreateAttributeTitleToNamingPatternMap	(	string[]	attributeTitles,
		string[]	titlePatterns
	)

inline

Creates a map object of attribute titles to their corresponding naming pattern

Created in NX12.0.0

License requirements: None.

Parameters

attributeTitles
titlePatterns

Returns

Implements NXOpen.IAttributeSourceObjectBuilder.

unsafe void NXOpen.PDM.PartOperationBuilder.CreateLogicalObjects ( out NXOpen.PDM.LogicalObject[] logicalObjects )

inline

Creates the pre-creation objects for the parts

Created in NX9.0.0

License requirements: None.

Parameters

logicalObjects

unsafe void NXOpen.PDM.PartOperationBuilder.CreateNonMasterListForLogicalObject ( NXOpen.PDM.LogicalObject logicalObject )

inline

Create NonMaster list for the selected logical Object

Created in NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCopyBuilder.CreateNonMasterListForCopyLogicalObject instead

License requirements: None.

Parameters

logicalObject

unsafe void NXOpen.PDM.PartOperationBuilder.CreateSpecificationsForLogicalObjects ( NXOpen.PDM.LogicalObject[] logicalObjects )

inline

Create new specifications for Logical Objects

Created in NX9.0.0

License requirements: None.

Parameters

logicalObjects

unsafe bool NXOpen.PDM.PartOperationBuilder.EditNonMasterName	(	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 NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCopyBuilder.EditNonMasterToCopyName instead

License requirements: None.

Parameters

logicalObject
oldName	the non-master part whose save as name is being set here
newName	the new name

Returns: flag to indicate whether the newName is valid

unsafe NXOpen.PDM.AlternateIdManager NXOpen.PDM.PartOperationBuilder.GetAlternateIDManager ( NXOpen.PDM.LogicalObject logicalObject )

inline

Create an instance of a NXOpen.PDM.AlternateIdManager class that will be used to create alternate ID information while creating the new part.

CreateSpec call should happen before calling this method.

Created in NX9.0.0

License requirements: None.

Parameters

logicalObject

Returns: the new NXOpen.PDM.AlternateIdManager instance

unsafe NXOpen.PDM.PartOperationBuilder.OperationType NXOpen.PDM.PartOperationBuilder.GetDialogOperation ( )

inline

Returns the dialog operation Applicable only for operation types PartOperationBuilder.OperationType.SaveAs and PartOperationBuilder.OperationType.Revise

Created in NX9.0.0

License requirements: None.

Returns

unsafe NXOpen.PDM.ErrorMessageHandler NXOpen.PDM.PartOperationBuilder.GetErrorMessageHandler ( bool refresh )

inline

Returns ErrorMessageHandler

Created in NX12.0.0

License requirements: None.

Parameters

refresh

Returns

unsafe NXOpen.PDM.PartOperationBuilder.NonMasterSaveAs NXOpen.PDM.PartOperationBuilder.GetNonMasterCopyOption ( NXOpen.PDM.LogicalObject logicalObject )

inline

Get the nonmasters saveAs option for given logical object.

Save As option can be one of these PartOperationBuilder.NonMasterSaveAs.All and PartOperationBuilder.NonMasterSaveAs.None

Created in NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCopyBuilder.GetCopyNonMasterPartsOption instead

License requirements: None.

Parameters

logicalObject

Returns

unsafe string [] NXOpen.PDM.PartOperationBuilder.GetNonMasterList ( NXOpen.PDM.LogicalObject logicalObject )

inline

Gets NonMaster list for the given logical Object

Created in NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCopyBuilder.GetNonMasterListForCopyLogicalObject instead

License requirements: None.

Parameters

logicalObject

Returns: Non-master part file names

unsafe NXOpen.ErrorList NXOpen.PDM.PartOperationBuilder.GetOperationFailures ( )

inline

Returns part operation failures

Created in NX9.0.0

Deprecated in NX12.0.0. Use NXOpen.PDM.PartOperationBuilder.GetErrorMessageHandler instead

License requirements: None.

Returns

unsafe bool NXOpen.PDM.PartOperationBuilder.IsNonMasterBeingCopied	(	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 NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCopyBuilder.IsNonMasterForLogicalObjectBeingCopied instead

License requirements: None.

Parameters

logicalObject
partName	the 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.PartOperationBuilder.SetDialogOperation ( NXOpen.PDM.PartOperationBuilder.OperationType dialogOperation )

inline

Sets the dialog operation.

Applicable only for operation types PartOperationBuilder.OperationType.SaveAs and PartOperationBuilder.OperationType.Revise

Created in NX9.0.0

License requirements: None.

Parameters

dialogOperation

unsafe void NXOpen.PDM.PartOperationBuilder.SetNonMasterSaveAsOption	(	NXOpen.PDM.LogicalObject	logicalObject,
		NXOpen.PDM.PartOperationBuilder.NonMasterSaveAs	saveOption
	)

inline

Set the nonmasters saveAs option for given logical object

Created in NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCopyBuilder.SetCopyNonMasterPartsOption instead

License requirements: None.

Parameters

logicalObject
saveOption

unsafe void NXOpen.PDM.PartOperationBuilder.SetSelectedNonMasterToSaveAs	(	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 NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCopyBuilder.SetSelectedNonMasterToCopy instead

License requirements: None.

Parameters

logicalObject
partName	the non-master part whose save option is being set here

unsafe void NXOpen.PDM.PartOperationBuilder.SetSelectedParts	(	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 NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCopyBuilder.SetSelectedPartsToCopy instead

License requirements: None.

Parameters

selectedParts
failedParts

unsafe void NXOpen.PDM.PartOperationBuilder.ValidateLogicalObjectsToCommit ( )

inline

Validates NXOpen.PDM.LogicalObject objects with this builder and udpates the operation failuers.

NXOpen.PDM.PartOperationBuilder.GetOperationFailures can be called to get the errors occurred during this operation.

Created in NX9.0.0

License requirements: None.

Property Documentation

unsafe string NXOpen.PDM.PartOperationBuilder.DefaultDestinationFolder

getset

Returns or sets the default destination folder string for the part being created .

It will be ignored in case of revise and creation of non-masters. The default destination folder string can be <username>:<folder>:<folder>, or :<folder>:<folder> means username is optional. In case of :<folder>:<folder>, the first : indicates Home, for example, :Newstuff, is the Newstuff folder in current user's Home container.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PDM.PartOperationBuilder.DependentFileSaveAs NXOpen.PDM.PartOperationBuilder.DependentFileSaveAsOption

getset

Returns or sets the Dependent files Save As option.

Save As option can be one of these PartOperationBuilder.DependentFileSaveAs.All and PartOperationBuilder.DependentFileSaveAs.None

Created in NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCopyBuilder.DependentFilesToCopyOption instead

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PDM.PartOperationBuilder.ReplaceAllComponents

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 NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCopyBuilder.ReplaceAllComponentsInSession instead

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:

PDM_PartOperationBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation