TextWithEditControlsBuilder Class¶
-
class
NXOpen.Annotations.
TextWithEditControlsBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
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
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
Tag | Returns the Tag for this object. |
TextBlock | Returns the text with symbols builder |
Methods¶
Method | Description |
---|---|
GetEditorText | Text from the editor text @return |
SetEditorText | Text into the editor text |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
TextBlock¶
-
TextWithEditControlsBuilder.
TextBlock
¶ Returns the text with symbols builder
-------------------------------------
Getter Method
Signature
TextBlock()
Returns: Return type: NXOpen.Annotations.TextWithSymbolsBuilder
New in version NX6.0.0.
License requirements: None.
Method Detail¶
GetEditorText¶
-
TextWithEditControlsBuilder.
GetEditorText
¶ Text from the editor text
Signature
GetEditorText()
Returns: Return type: list of str New in version NX6.0.0.
License requirements: None.
SetEditorText¶
-
TextWithEditControlsBuilder.
SetEditorText
¶ Text into the editor text
Signature
SetEditorText(text)
Parameters: text (list of str) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Validate¶
-
TextWithEditControlsBuilder.
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.