Represents 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
Created in NX10.0.0.
More...
Public Member Functions | |
| NXString | DestinationPath () |
| Returns the path of folder to publish into Created in NX10.0.0. More... | |
| bool | IsFolder () |
| Returns the type of object to pblish. More... | |
| NXOpen::Layout2d::Layout2dDefinitionLocation | Location () |
| Returns the location type of folder to publish into Created in NX10.0.0. More... | |
| NXString | OriginPath () |
| Returns the path of folder or definition to publish Created in NX10.0.0. More... | |
| void | SetDestinationPath (const NXString &destinationPath) |
| Sets the path of folder to publish into Created in NX10.0.0. More... | |
| void | SetDestinationPath (const char *destinationPath) |
| Sets the path of folder to publish into Created in NX10.0.0. More... | |
| void | SetFolder (bool isFolder) |
| Sets the type of object to pblish. More... | |
| void | SetLocation (NXOpen::Layout2d::Layout2dDefinitionLocation locationType) |
| Sets the location type of folder to publish into Created in NX10.0.0. More... | |
| void | SetOriginPath (const NXString &originPath) |
| Sets the path of folder or definition to publish Created in NX10.0.0. More... | |
| void | SetOriginPath (const char *originPath) |
| Sets the path of folder or definition to publish Created in NX10.0.0. More... | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| Commits any edits that have been applied to the builder. More... | |
| void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. More... | |
| std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. More... | |
| NXOpen::NXObject * | GetObject () |
| Returns the object currently being edited by this builder. More... | |
| void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
Represents 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
Created in NX10.0.0.
Member Function Documentation
| NXString NXOpen::Layout2d::PublishComponentBuilder::DestinationPath | ( | ) |
Returns the path of folder to publish into
Created in NX10.0.0.
License requirements : None
| bool NXOpen::Layout2d::PublishComponentBuilder::IsFolder | ( | ) |
Returns the type of object to pblish.
Can be definition or folder
Created in NX10.0.0.
License requirements : nx_layout ("NX Layout")
| NXOpen::Layout2d::Layout2dDefinitionLocation NXOpen::Layout2d::PublishComponentBuilder::Location | ( | ) |
Returns the location type of folder to publish into
Created in NX10.0.0.
License requirements : nx_layout ("NX Layout")
| NXString NXOpen::Layout2d::PublishComponentBuilder::OriginPath | ( | ) |
Returns the path of folder or definition to publish
Created in NX10.0.0.
License requirements : None
| void NXOpen::Layout2d::PublishComponentBuilder::SetDestinationPath | ( | const NXString & | destinationPath | ) |
Sets the path of folder to publish into
Created in NX10.0.0.
License requirements : nx_layout ("NX Layout")
- Parameters
-
destinationPath destinationpath
| void NXOpen::Layout2d::PublishComponentBuilder::SetDestinationPath | ( | const char * | destinationPath | ) |
Sets the path of folder to publish into
Created in NX10.0.0.
License requirements : nx_layout ("NX Layout")
- Parameters
-
destinationPath destinationpath
| void NXOpen::Layout2d::PublishComponentBuilder::SetFolder | ( | bool | isFolder | ) |
Sets the type of object to pblish.
Can be definition or folder
Created in NX10.0.0.
License requirements : nx_layout ("NX Layout")
- Parameters
-
isFolder isfolder
| void NXOpen::Layout2d::PublishComponentBuilder::SetLocation | ( | NXOpen::Layout2d::Layout2dDefinitionLocation | locationType | ) |
Sets the location type of folder to publish into
Created in NX10.0.0.
License requirements : nx_layout ("NX Layout")
- Parameters
-
locationType locationtype
| void NXOpen::Layout2d::PublishComponentBuilder::SetOriginPath | ( | const NXString & | originPath | ) |
Sets the path of folder or definition to publish
Created in NX10.0.0.
License requirements : nx_layout ("NX Layout")
- Parameters
-
originPath originpath
| void NXOpen::Layout2d::PublishComponentBuilder::SetOriginPath | ( | const char * | originPath | ) |
Sets the path of folder or definition to publish
Created in NX10.0.0.
License requirements : nx_layout ("NX Layout")
- Parameters
-
originPath originpath
The documentation for this class was generated from the following file:
- Layout2d_PublishComponentBuilder.hxx