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

Represents a NXOpen::Annotations::TextWithEditControlsBuilder which collects internationalized text strings from the user for processing on an annotation object. More...

Inheritance diagram for NXOpen::Annotations::TextWithEditControlsBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

std::vector< NXStringGetEditorText ()
 Text from the editor text. More...
 
void SetEditorText (const std::vector< NXString > &text)
 Text into the editor text
Created in NX6.0.0. More...
 
NXOpen::Annotations::TextWithSymbolsBuilderTextBlock ()
 Returns the text with symbols builder
Created in NX6.0.0. 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 NXOpen::Annotations::TextWithEditControlsBuilder which collects internationalized text strings from the user for processing on an annotation object.


This is a sub-builder class and cannot be directly instantiated

Created in NX6.0.0.

Member Function Documentation

std::vector<NXString> NXOpen::Annotations::TextWithEditControlsBuilder::GetEditorText ( )

Text from the editor text.

Returns

Created in NX6.0.0.

License requirements : None
void NXOpen::Annotations::TextWithEditControlsBuilder::SetEditorText ( const std::vector< NXString > &  text)

Text into the editor text
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters
texttext
NXOpen::Annotations::TextWithSymbolsBuilder* NXOpen::Annotations::TextWithEditControlsBuilder::TextBlock ( )

Returns the text with symbols builder
Created in NX6.0.0.



License requirements : None

virtual bool NXOpen::Annotations::TextWithEditControlsBuilder::Validate ( )
virtual

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.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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