ReparentComponentBuilder Class

class NXOpen.Layout2d.ReparentComponentBuilder

Bases: NXOpen.Builder

Represents a Builder for Reparent 2D Component functionality which will reparents * the selected 2D Component contents from another 2D Component definition.

To create a new instance of this class, use NXOpen.Layout2d.ComponentCollection.CreateReparentComponentBuilder()

New in version NX11.0.0.

Properties

Property Description
Components Returns the select 2D Components to reparent the definitions
CreateCopy Returns or sets the flag to distinguish copy and cut operations
Tag Returns the Tag for this object.
Target Returns or sets the target of 2D Components reparent operation

Methods

Method Description
AddComponents Add a list of 2D Components
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

Components

ReparentComponentBuilder.Components

Returns the select 2D Components to reparent the definitions

-------------------------------------

Getter Method

Signature Components

Returns:
Return type:NXOpen.Layout2d.SelectComponentList

New in version NX11.0.0.

License requirements: None.

CreateCopy

ReparentComponentBuilder.CreateCopy

Returns or sets the flag to distinguish copy and cut operations

-------------------------------------

Getter Method

Signature CreateCopy

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CreateCopy

Parameters:createCopy (bool) –

New in version NX11.0.0.

License requirements: None.

Target

ReparentComponentBuilder.Target

Returns or sets the target of 2D Components reparent operation

-------------------------------------

Getter Method

Signature Target

Returns:
Return type:NXOpen.DisplayableObject

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Target

Parameters:target (NXOpen.DisplayableObject) –

New in version NX11.0.0.

License requirements: None.

Method Detail

AddComponents

ReparentComponentBuilder.AddComponents

Add a list of 2D Components

Signature AddComponents(components)

Parameters:components (list of NXOpen.Layout2d.Component) –

New in version NX11.0.0.

License requirements: None.

Validate

ReparentComponentBuilder.Validate

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.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.