AddObjectsToRegionBuilder Class¶
-
class
NXOpen.Drawings.AddObjectsToRegionBuilder¶ Bases:
NXOpen.BuilderCreates the builder for associating the symbols from library to the region
To create a new instance of this class, use
NXOpen.Drawings.DrawingRegionCollection.CreateAddObjectsToRegionBuilder()New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| SelectedRegion | Returns the get selected region |
| 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. |
| SetMasterSymbolFilePaths | Set the master symbol paths |
| 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¶
SelectedRegion¶
-
AddObjectsToRegionBuilder.SelectedRegion¶ Returns the get selected region
-------------------------------------Getter Method
Signature
SelectedRegionReturns: Return type: NXOpen.Drawings.SelectDrawingRegionNew in version NX8.0.0.
License requirements: None.
Method Detail¶
SetMasterSymbolFilePaths¶
-
AddObjectsToRegionBuilder.SetMasterSymbolFilePaths¶ Set the master symbol paths
Signature
SetMasterSymbolFilePaths(symbolPath)Parameters: symbolPath (list of str) – the list of selected symbol paths New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
Validate¶
-
AddObjectsToRegionBuilder.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.