LocalDefinitionFolderBuilder Class¶
-
class
NXOpen.Layout2d.LocalDefinitionFolderBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Layout2d.LocalDefinitionFolderBuilder.A local definition folder contains 2D Component definitions stored in the current part.
To create a new instance of this class, use
NXOpen.Layout2d.LocalDefinitionFolderCollection.CreateLocalDefinitionFolderBuilder()New in version NX10.0.0.
Properties¶
| Property | Description |
|---|---|
| FolderName | Returns or sets the current folder name |
| Parent | Returns or sets the current folder’s parent |
| 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¶
FolderName¶
-
LocalDefinitionFolderBuilder.FolderName¶ Returns or sets the current folder name
-------------------------------------Getter Method
Signature
FolderNameReturns: folder name Return type: str New in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
-------------------------------------Setter Method
Signature
FolderNameParameters: folderName (str) – folder name New in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
Parent¶
-
LocalDefinitionFolderBuilder.Parent¶ Returns or sets the current folder’s parent
-------------------------------------Getter Method
Signature
ParentReturns: parent local definition folder Return type: NXOpen.Layout2d.LocalDefinitionFolderNew in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
-------------------------------------Setter Method
Signature
ParentParameters: parentfolder ( NXOpen.Layout2d.LocalDefinitionFolder) – parent local definition folderNew in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
Method Detail¶
Validate¶
-
LocalDefinitionFolderBuilder.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.