ReplaceComponentBuilder Class¶
-
class
NXOpen.Layout2d.ReplaceComponentBuilder¶ Bases:
NXOpen.BuilderRepresents a Builder for Replace 2D Component functionality which will replaces * the selected 2D Component contents from another 2D Component definition.
To create a new instance of this class, use
NXOpen.Layout2d.ComponentCollection.CreateReplaceComponentBuilder()New in version NX10.0.0.
Properties¶
| Property | Description |
|---|---|
| Components | Returns the select 2D Components to replace the definitions |
| Location | Returns or sets the location type of the 2D Component definition to replace * indicating local, native or team center |
| Path | Returns or sets the path of the 2D Component definition to replace |
| ReplaceAll | Returns or sets the flag indicating whether to replace all instances of selected components |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| 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¶
-
ReplaceComponentBuilder.Components¶ Returns the select 2D Components to replace the definitions
-------------------------------------Getter Method
Signature
ComponentsReturns: Return type: NXOpen.Layout2d.SelectComponentListNew in version NX10.0.0.
License requirements: None.
Location¶
-
ReplaceComponentBuilder.Location¶ Returns or sets the location type of the 2D Component definition to replace * indicating local, native or team center
-------------------------------------Getter Method
Signature
LocationReturns: Return type: NXOpen.Layout2d.Layout2dDefinitionLocationNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LocationParameters: locationType ( NXOpen.Layout2d.Layout2dDefinitionLocation) –New in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
Path¶
-
ReplaceComponentBuilder.Path¶ Returns or sets the path of the 2D Component definition to replace
-------------------------------------Getter Method
Signature
PathReturns: Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PathParameters: path (str) – New in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
ReplaceAll¶
-
ReplaceComponentBuilder.ReplaceAll¶ Returns or sets the flag indicating whether to replace all instances of selected components
-------------------------------------Getter Method
Signature
ReplaceAllReturns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReplaceAllParameters: replaceAll (bool) – New in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
Method Detail¶
Validate¶
-
ReplaceComponentBuilder.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.