NXOpen.Builder Class Reference

A Builder is an object that is used to create and edit other objects. More...

Inheritance diagram for NXOpen.Builder:

Public Member Functions
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.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

A Builder is an object that is used to create and edit other objects.

This is an abstract class that provides the basic functionality common to all builders. See the Builder subclasses for details of application-specific builders.

All Builders use a transaction model. A new builder is created, and its methods are called to make changes. These changes are not applied to the session until the NXOpen.Builder.Commit method is invoked.

Once a Builder has been committed, it should be deleted using the NXOpen.Builder.Destroy . Alternatively, any edits made can be discarded by deleting the builder without calling commit.

This is an abstract class, and cannot be instantiated.

Created in NX4.0.0

Member Function Documentation

unsafe NXOpen.NXObject NXOpen.Builder.Commit ( )

inline

Commits any edits that have been applied to the builder.

Returns the object being edited, or a new object if the builder is being used in creation mode.

In certain cases this method may not return an object, please consult the particular class's documentation to see if this method has a different behavior.

Created in NX4.0.0

License requirements: None.

Returns

The object being edited, or the new object.

unsafe void NXOpen.Builder.Destroy ( )

inline

Deletes the builder, and cleans up any objects created by the builder.

This method should always be called when a builder has been committed or is no longer needed.

Created in NX4.0.0

License requirements: None.

unsafe NXOpen.NXObject [] NXOpen.Builder.GetCommittedObjects ( )

inline

For builders that create more than one object, this method returns the objects that are created by commit.

Created in NX6.0.0

License requirements: None.

Returns

The objects created by Commit

unsafe NXOpen.NXObject NXOpen.Builder.GetObject ( )

inline

Returns the object currently being edited by this builder.

If a new object is being created, and the builder has not yet been commited, returns a null reference (Nothing in Visual Basic).

Created in NX4.0.0

License requirements: None.

Returns

unsafe void NXOpen.Builder.ShowResults ( )

inline

Updates the model to reflect the result of an edit to the model for all builders that support showing results.

Created in NX7.5.0

License requirements: None.

unsafe bool NXOpen.Builder.Validate ( )

inline

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Created in NX3.0.1

License requirements: None.

Returns

Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.PreviewBuilder NXOpen.Builder.PreviewBuilder

get

Returns the preview builder subobject.

Created in NX1847.0.0

License requirements: None.

---

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

• Builder.cs