NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Layout2d::ReplaceComponentBuilder Class Reference

Represents a Builder for Replace 2D Component functionality which will replaces the selected 2D Component contents from another 2D Component definition. More...

Inheritance diagram for NXOpen::Layout2d::ReplaceComponentBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::Layout2d::SelectComponentListComponents ()
 Returns the select 2D Components to replace the definitions
Created in NX10.0.0. More...
 
NXOpen::Layout2d::Layout2dDefinitionLocation Location ()
 Returns the location type of the 2D Component definition to replace indicating local, native or team center. More...
 
NXString Path ()
 Returns the path of the 2D Component definition to replace
Created in NX10.0.0. More...
 
bool ReplaceAll ()
 Returns the flag indicating whether to replace all instances of selected components
Created in NX10.0.0. More...
 
void SetLocation (NXOpen::Layout2d::Layout2dDefinitionLocation locationType)
 Sets the location type of the 2D Component definition to replace indicating local, native or team center. More...
 
void SetPath (const NXString &path)
 Sets the path of the 2D Component definition to replace
Created in NX10.0.0. More...
 
void SetPath (const char *path)
 Sets the path of the 2D Component definition to replace
Created in NX10.0.0. More...
 
void SetReplaceAll (bool replaceAll)
 Sets the flag indicating whether to replace all instances of selected components
Created in NX10.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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 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

Created in NX10.0.0.

Member Function Documentation

NXOpen::Layout2d::SelectComponentList* NXOpen::Layout2d::ReplaceComponentBuilder::Components ( )

Returns the select 2D Components to replace the definitions
Created in NX10.0.0.



License requirements : None

NXOpen::Layout2d::Layout2dDefinitionLocation NXOpen::Layout2d::ReplaceComponentBuilder::Location ( )

Returns the location type of the 2D Component definition to replace indicating local, native or team center.


Created in NX10.0.0.

License requirements : None

NXString NXOpen::Layout2d::ReplaceComponentBuilder::Path ( )

Returns the path of the 2D Component definition to replace
Created in NX10.0.0.



License requirements : None

bool NXOpen::Layout2d::ReplaceComponentBuilder::ReplaceAll ( )

Returns the flag indicating whether to replace all instances of selected components
Created in NX10.0.0.



License requirements : None

void NXOpen::Layout2d::ReplaceComponentBuilder::SetLocation ( NXOpen::Layout2d::Layout2dDefinitionLocation  locationType)

Sets the location type of the 2D Component definition to replace indicating local, native or team center.


Created in NX10.0.0.

License requirements : nx_layout ("NX Layout")

Parameters
locationTypelocationtype
void NXOpen::Layout2d::ReplaceComponentBuilder::SetPath ( const NXString path)

Sets the path of the 2D Component definition to replace
Created in NX10.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
pathpath
void NXOpen::Layout2d::ReplaceComponentBuilder::SetPath ( const char *  path)

Sets the path of the 2D Component definition to replace
Created in NX10.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
pathpath
void NXOpen::Layout2d::ReplaceComponentBuilder::SetReplaceAll ( bool  replaceAll)

Sets the flag indicating whether to replace all instances of selected components
Created in NX10.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
replaceAllreplaceall

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.