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

Inheritance diagram for NXOpen.Assemblies.DesignElementBuilder:

Public Types
enum	EditActionType { Category, Partitions, Effectivity }
	Represents the edit action on a design element More...

enum	LayerOptionType { Original, Work, AsSpecified }
	Represents the layer option of a design element More...

enum	OperationType { Create, Edit, SaveAs, Save, SaveAndClose, Undefined }
	Represents an operation type that can be performed on a design element More...

enum	PositioningOption { AbsoluteOrigin, Maintain, AsSpecified }
	Represents the positioning option of a design element. More...

enum	ReferenceSetType { Model, EntirePart, AsSpecified }
	Represents the reference set of a design element More...

enum	SaveAsActionType { NewRevision, NewDesignElement }
	Represents the save as action on a design element More...

enum	StateType { Shape, Reuse, Promissory }
	Represents the state of a design element More...

Public Member Functions
unsafe void	AddToPartitions (NXOpen.Assemblies.Partition[] partitions)
	Specify partitions to which the design elements will be added. 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 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 design elements More...

unsafe void	GetAddPartitions (out NXOpen.Assemblies.Partition[] partitions)
	Get the partitions to which the design elements will be added. More...

unsafe NXOpen.ErrorList	GetOperationFailures ()
	Returns design element operation failures More...

unsafe void	GetPosition (out NXOpen.Point3d position, out NXOpen.Matrix3x3 orientation)
	Gets the position of design element More...

unsafe void	GetRemovePartitions (out NXOpen.Assemblies.Partition[] partitions)
	Get the partitions from which the design elements will be removed. More...

unsafe void	PartiallyCommit (NXOpen.PDM.LogicalObject[] logicalObjects)
	Equivalent to builder Commit call but this one would create design elements with minimal required information. More...

unsafe void	RemoveFromPartitions (NXOpen.Assemblies.Partition[] partitions)
	Specify partitions from which the design elements will be removed. More...

unsafe void	SetPosition (NXOpen.Point3d position, NXOpen.Matrix3x3 orientation)
	Sets the position of design element. 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 int	Count `[get, set]`
	Returns or sets the number of design elements to be created. More...

unsafe NXOpen.SelectDisplayableObjectList	DesignElementsToOperate `[get]`
	Returns the design elements to operate upon More...

unsafe string	DesignElementType `[get, set]`
	Returns or sets the type of a design element More...

unsafe NXOpen.Assemblies.DesignElementBuilder.EditActionType	EditAction `[get, set]`
	Returns or sets the edit action type on a design element More...

unsafe NXOpen.PDM.EffectivityTableBuilder	EffectivityTable `[get]`
	Returns the effectivity interface of a design element More...

unsafe NXOpen.FileNew	FileNewDescriptor `[get]`
	Returns the file new descriptor to identify a design element More...

unsafe bool	KeepOriginalDesignElement `[get, set]`
	Returns or sets the option determines whether to keep the original design element in the subset during save as More...

unsafe int	Layer `[get, set]`
	Returns or sets the layer value of a design element. More...

unsafe NXOpen.Assemblies.DesignElementBuilder.LayerOptionType	LayerOption `[get, set]`
	Returns or sets the layer option of a design element More...

unsafe NXOpen.Assemblies.Subset	OwningSubsetInstance `[get, set]`
	Returns or sets the owning subset instance More...

unsafe NXOpen.BasePart	PartToUse `[get, set]`
	Returns or sets the part to use of a reuse design element. More...

unsafe NXOpen.Assemblies.DesignElementBuilder.PositioningOption	PositioningOptionValue `[get, set]`
	Returns or sets the positioning option of a design element More...

unsafe NXOpen.Assemblies.DesignElementBuilder.ReferenceSetType	ReferenceSet `[get, set]`
	Returns or sets the reference set of a design element More...

unsafe string	ReferenceSetName `[get, set]`
	Returns or sets the reference set name of a design element. More...

unsafe NXOpen.Assemblies.DesignElementBuilder.SaveAsActionType	SaveAsAction `[get, set]`
	Returns or sets the save as action type of a design element More...

unsafe bool	Scatter `[get, set]`
	Returns or sets the option to determine whether to scatter design elements during creation More...

unsafe NXOpen.Assemblies.DesignElementBuilder.StateType	State `[get, set]`
	Returns or sets the state of a design element 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.Assemblies.DesignElementBuilder.OperationType

To create a new instance of this class, use NXOpen.CollaborativeContentManager.CreateDesignElementBuilder

Default values.

Property

Value

EditAction

Partitions

KeepOriginalDesignElement

0

LayerOption

Original

PositioningOptionValue

Maintain

ReferenceSet

EntirePart

SaveAsAction

NewRevision

Created in NX8.5.0

Member Enumeration Documentation

enum NXOpen.Assemblies.DesignElementBuilder.EditActionType

Represents the edit action on a design element

Enumerator
Category
Partitions
Effectivity

enum NXOpen.Assemblies.DesignElementBuilder.LayerOptionType

Represents the layer option of a design element

Enumerator
Original	Original layer
Work	Work layer
AsSpecified	As specified layer

enum NXOpen.Assemblies.DesignElementBuilder.OperationType

Represents an operation type that can be performed on a design element

Enumerator
Create	Creates a design element
Edit	Edits a design element
SaveAs	Save as a design element
Save	Saves a design element
SaveAndClose	Saves a design element and if it is a reuse closes the reused part
Undefined

enum NXOpen.Assemblies.DesignElementBuilder.PositioningOption

Represents the positioning option of a design element.

Enumerator

AbsoluteOrigin

Applies absolute origin position on the design elements

Maintain

Maintains the existing positions of the design elements.

Applicable only if the edit action type is set to DesignElementBuilder.EditActionType.Category

AsSpecified

Applies the specified position on the design elements

enum NXOpen.Assemblies.DesignElementBuilder.ReferenceSetType

Represents the reference set of a design element

Enumerator
Model	Model
EntirePart	Entire part
AsSpecified	As specified reference set

enum NXOpen.Assemblies.DesignElementBuilder.SaveAsActionType

Represents the save as action on a design element

Enumerator
NewRevision
NewDesignElement

enum NXOpen.Assemblies.DesignElementBuilder.StateType

Represents the state of a design element

Enumerator
Shape	Shape design element
Reuse	Reuse design element
Promissory	Promissory design element

Member Function Documentation

unsafe void NXOpen.Assemblies.DesignElementBuilder.AddToPartitions ( NXOpen.Assemblies.Partition[] partitions )

inline

Specify partitions to which the design elements will be added.

The design elements will remain a member of any partitions to which they already belongs. The partitions to which the design elements will be added accumulate if this method is called more than once. If both Assemblies.DesignElementBuilder.AddToPartitions and Assemblies.DesignElementBuilder.RemoveFromPartitions are called with the same partition then the design elements will be added or removed from that partition depending upon which was the last method called.

Created in NX8.5.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters

partitions

unsafe NXOpen.ErrorList NXOpen.Assemblies.DesignElementBuilder.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.Assemblies.DesignElementBuilder.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 NXOpen.NXObject NXOpen.Assemblies.DesignElementBuilder.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.Assemblies.DesignElementBuilder.CreateLogicalObjects ( out NXOpen.PDM.LogicalObject[] logicalObjects )

inline

Creates the pre-creation objects for the design elements

Created in NX8.5.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters

logicalObjects

unsafe void NXOpen.Assemblies.DesignElementBuilder.GetAddPartitions ( out NXOpen.Assemblies.Partition[] partitions )

inline

Get the partitions to which the design elements will be added.

Created in NX8.5.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters

partitions

unsafe NXOpen.ErrorList NXOpen.Assemblies.DesignElementBuilder.GetOperationFailures ( )

inline

Returns design element operation failures

Created in NX8.5.0

License requirements: None.

Returns

unsafe void NXOpen.Assemblies.DesignElementBuilder.GetPosition	(	out NXOpen.Point3d	position,
		out NXOpen.Matrix3x3	orientation
	)

inline

Gets the position of design element

Created in NX8.5.0

License requirements: None.

Parameters

position
orientation

unsafe void NXOpen.Assemblies.DesignElementBuilder.GetRemovePartitions ( out NXOpen.Assemblies.Partition[] partitions )

inline

Get the partitions from which the design elements will be removed.

Created in NX8.5.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters

partitions

unsafe void NXOpen.Assemblies.DesignElementBuilder.PartiallyCommit ( NXOpen.PDM.LogicalObject[] logicalObjects )

inline

Equivalent to builder Commit call but this one would create design elements with minimal required information.

Can be used only when this NXOpen.Assemblies.DesignElementBuilder has been created with NXOpen.Assemblies.DesignElementBuilder.OperationType.Create . Call to builder Commit is required after this to Commit creation.

Created in NX11.0.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters

logicalObjects

unsafe void NXOpen.Assemblies.DesignElementBuilder.RemoveFromPartitions ( NXOpen.Assemblies.Partition[] partitions )

inline

Specify partitions from which the design elements will be removed.

The partitions from which the design elements will be removed accumulate if this method is called more than once. If both Assemblies.DesignElementBuilder.AddToPartitions and Assemblies.DesignElementBuilder.RemoveFromPartitions are called with the same partition then the design elements will be added or removed from that partition depending upon which was the last method called.

Created in NX8.5.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters

partitions

unsafe void NXOpen.Assemblies.DesignElementBuilder.SetPosition	(	NXOpen.Point3d	position,
		NXOpen.Matrix3x3	orientation
	)

inline

Sets the position of design element.

This value is used only when positioning option is DesignElementBuilder.PositioningOption.AsSpecified

Created in NX8.5.0

License requirements: nx_4gd_integration ("4th Generation Design")

Parameters

position
orientation

Property Documentation

unsafe int NXOpen.Assemblies.DesignElementBuilder.Count

getset

Returns or sets the number of design elements to be created.

Applicable only if the operation type is set to DesignElementBuilder.OperationType.Create

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.SelectDisplayableObjectList NXOpen.Assemblies.DesignElementBuilder.DesignElementsToOperate

get

Returns the design elements to operate upon

Created in NX8.5.0

License requirements: None.

unsafe string NXOpen.Assemblies.DesignElementBuilder.DesignElementType

getset

Returns or sets the type of a design element

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.Assemblies.DesignElementBuilder.EditActionType NXOpen.Assemblies.DesignElementBuilder.EditAction

getset

Returns or sets the edit action type on a design element

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.PDM.EffectivityTableBuilder NXOpen.Assemblies.DesignElementBuilder.EffectivityTable

get

Returns the effectivity interface of a design element

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.FileNew NXOpen.Assemblies.DesignElementBuilder.FileNewDescriptor

get

Returns the file new descriptor to identify a design element

Created in NX8.5.0

License requirements: None.

unsafe bool NXOpen.Assemblies.DesignElementBuilder.KeepOriginalDesignElement

getset

Returns or sets the option determines whether to keep the original design element in the subset during save as

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe int NXOpen.Assemblies.DesignElementBuilder.Layer

getset

Returns or sets the layer value of a design element.

Applicable only if the layer option is set to DesignElementBuilder.LayerOptionType.AsSpecified

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.Assemblies.DesignElementBuilder.LayerOptionType NXOpen.Assemblies.DesignElementBuilder.LayerOption

getset

Returns or sets the layer option of a design element

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.Assemblies.Subset NXOpen.Assemblies.DesignElementBuilder.OwningSubsetInstance

getset

Returns or sets the owning subset instance

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.BasePart NXOpen.Assemblies.DesignElementBuilder.PartToUse

getset

Returns or sets the part to use of a reuse design element.

Applicable only if the state is set to DesignElementBuilder.StateType.Reuse

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.Assemblies.DesignElementBuilder.PositioningOption NXOpen.Assemblies.DesignElementBuilder.PositioningOptionValue

getset

Returns or sets the positioning option of a design element

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.Assemblies.DesignElementBuilder.ReferenceSetType NXOpen.Assemblies.DesignElementBuilder.ReferenceSet

getset

Returns or sets the reference set of a design element

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe string NXOpen.Assemblies.DesignElementBuilder.ReferenceSetName

getset

Returns or sets the reference set name of a design element.

Applicable only if the reference set is set to DesignElementBuilder.ReferenceSetType.AsSpecified

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.Assemblies.DesignElementBuilder.SaveAsActionType NXOpen.Assemblies.DesignElementBuilder.SaveAsAction

getset

Returns or sets the save as action type of a design element

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe bool NXOpen.Assemblies.DesignElementBuilder.Scatter

getset

Returns or sets the option to determine whether to scatter design elements during creation

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

unsafe NXOpen.Assemblies.DesignElementBuilder.StateType NXOpen.Assemblies.DesignElementBuilder.State

getset

Returns or sets the state of a design element

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: nx_4gd_integration ("4th Generation Design")

The documentation for this class was generated from the following file:

Assemblies_DesignElementBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation