PublishComponentBuilder Class¶
-
class
NXOpen.Layout2d.PublishComponentBuilder¶ Bases:
NXOpen.BuilderRepresents a Builder for Publish 2D Component functionality which will allow local definitions to be exported into external storage locations
To create a new instance of this class, use
NXOpen.Layout2d.ComponentCollection.CreatePublishComponentBuilder()New in version NX10.0.0.
Properties¶
| Property | Description |
|---|---|
| DestinationPath | Returns or sets the path of folder to publish into |
| IsFolder | Returns or sets the type of object to pblish. |
| Location | Returns or sets the location type of folder to publish into |
| OriginPath | Returns or sets the path of folder or definition to publish |
| 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¶
DestinationPath¶
-
PublishComponentBuilder.DestinationPath¶ Returns or sets the path of folder to publish into
-------------------------------------Getter Method
Signature
DestinationPathReturns: Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DestinationPathParameters: destinationPath (str) – New in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
IsFolder¶
-
PublishComponentBuilder.IsFolder¶ Returns or sets the type of object to pblish.
Can be definition or folder
-------------------------------------Getter Method
Signature
IsFolderReturns: Return type: bool New in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
-------------------------------------Setter Method
Signature
IsFolderParameters: isFolder (bool) – New in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
Location¶
-
PublishComponentBuilder.Location¶ Returns or sets the location type of folder to publish into
-------------------------------------Getter Method
Signature
LocationReturns: Return type: NXOpen.Layout2d.Layout2dDefinitionLocationNew in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
-------------------------------------Setter Method
Signature
LocationParameters: locationType ( NXOpen.Layout2d.Layout2dDefinitionLocation) –New in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
OriginPath¶
-
PublishComponentBuilder.OriginPath¶ Returns or sets the path of folder or definition to publish
-------------------------------------Getter Method
Signature
OriginPathReturns: Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OriginPathParameters: originPath (str) – New in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
Method Detail¶
Validate¶
-
PublishComponentBuilder.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.