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

Represents a Builder for Replace Custom Symbol functionality
To create a new instance of this class, use NXOpen::Annotations::CustomSymbolCollection::CreateReplaceSymbolBuilder
Default values. More...

Inheritance diagram for NXOpen::Annotations::ReplaceSymbolBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool IsPartSymbol ()
 Returns the flag indicating whether the selected symbol is part symbol
Created in NX8.0.1. More...
 
bool ReplaceAll ()
 Returns the flag indicating whether to replace all instances of selected symbols
Created in NX8.0.1. More...
 
void SetPartSymbol (bool isPartSymbol)
 Sets the flag indicating whether the selected symbol is part symbol
Created in NX8.0.1. More...
 
void SetReplaceAll (bool replaceAll)
 Sets the flag indicating whether to replace all instances of selected symbols
Created in NX8.0.1. More...
 
void SetSymbolName (const NXString &symbolName)
 Sets the symbol name
Created in NX8.0.1. More...
 
void SetSymbolName (const char *symbolName)
 Sets the symbol name
Created in NX8.0.1. More...
 
void SetSymbolPath (const NXString &symbolPath)
 Sets the symbol path
Created in NX8.0.1. More...
 
void SetSymbolPath (const char *symbolPath)
 Sets the symbol path
Created in NX8.0.1. More...
 
NXOpen::Annotations::SelectBaseCustomSymbolListSymbol ()
 Returns the symbol
Created in NX8.0.1. More...
 
NXString SymbolName ()
 Returns the symbol name
Created in NX8.0.1. More...
 
NXString SymbolPath ()
 Returns the symbol path
Created in NX8.0.1. 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 Custom Symbol functionality
To create a new instance of this class, use NXOpen::Annotations::CustomSymbolCollection::CreateReplaceSymbolBuilder
Default values.

Property Value

ReplaceAll

0


Created in NX8.0.1.

Member Function Documentation

bool NXOpen::Annotations::ReplaceSymbolBuilder::IsPartSymbol ( )

Returns the flag indicating whether the selected symbol is part symbol
Created in NX8.0.1.



License requirements : None

bool NXOpen::Annotations::ReplaceSymbolBuilder::ReplaceAll ( )

Returns the flag indicating whether to replace all instances of selected symbols
Created in NX8.0.1.



License requirements : None

void NXOpen::Annotations::ReplaceSymbolBuilder::SetPartSymbol ( bool  isPartSymbol)

Sets the flag indicating whether the selected symbol is part symbol
Created in NX8.0.1.



License requirements : drafting ("DRAFTING")

Parameters
isPartSymbolispartsymbol
void NXOpen::Annotations::ReplaceSymbolBuilder::SetReplaceAll ( bool  replaceAll)

Sets the flag indicating whether to replace all instances of selected symbols
Created in NX8.0.1.



License requirements : drafting ("DRAFTING")

Parameters
replaceAllreplaceall
void NXOpen::Annotations::ReplaceSymbolBuilder::SetSymbolName ( const NXString symbolName)

Sets the symbol name
Created in NX8.0.1.



License requirements : drafting ("DRAFTING")

Parameters
symbolNamesymbolname
void NXOpen::Annotations::ReplaceSymbolBuilder::SetSymbolName ( const char *  symbolName)

Sets the symbol name
Created in NX8.0.1.



License requirements : drafting ("DRAFTING")

Parameters
symbolNamesymbolname
void NXOpen::Annotations::ReplaceSymbolBuilder::SetSymbolPath ( const NXString symbolPath)

Sets the symbol path
Created in NX8.0.1.



License requirements : drafting ("DRAFTING")

Parameters
symbolPathsymbolpath
void NXOpen::Annotations::ReplaceSymbolBuilder::SetSymbolPath ( const char *  symbolPath)

Sets the symbol path
Created in NX8.0.1.



License requirements : drafting ("DRAFTING")

Parameters
symbolPathsymbolpath
NXOpen::Annotations::SelectBaseCustomSymbolList* NXOpen::Annotations::ReplaceSymbolBuilder::Symbol ( )

Returns the symbol
Created in NX8.0.1.



License requirements : None

NXString NXOpen::Annotations::ReplaceSymbolBuilder::SymbolName ( )

Returns the symbol name
Created in NX8.0.1.



License requirements : None

NXString NXOpen::Annotations::ReplaceSymbolBuilder::SymbolPath ( )

Returns the symbol path
Created in NX8.0.1.



License requirements : None


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