CustomSymbolTextData Class¶
-
class
NXOpen.Annotations.
CustomSymbolTextData
¶ Bases:
NXOpen.TransientObject
Represents custom symbol text data
New in version NX4.0.0.
Deprecated since version NX9.0.0: Use
NXOpen.Annotations.MasterSymbolListItemBuilder
instead. UseNXOpen.Annotations.BaseCustomSymbolBuilder.Texts()
to query list of custom symbol texts.
Properties¶
Property | Description |
---|---|
ControlTextIndex | Returns or sets the control text index. |
IntegerValue | Returns or sets the integer value. |
RealValue | Returns or sets the real value. |
StringValue | Returns the string value. |
TextType | Returns the text type |
Methods¶
Method | Description |
---|---|
Dispose | Frees the object from memory. |
GetText | Returns the text. |
SetText | Sets the text. |
Property Detail¶
ControlTextIndex¶
-
CustomSymbolTextData.
ControlTextIndex
¶ Returns or sets the control text index.
Valid for the text type
NXOpen.Annotations.TextType.Controlled
.-------------------------------------
Getter Method
Signature
ControlTextIndex
Returns: Control text index Return type: int New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ControlTextIndex
Parameters: index (int) – New control text index New in version NX4.0.0.
License requirements: None.
IntegerValue¶
-
CustomSymbolTextData.
IntegerValue
¶ Returns or sets the integer value.
Valid for the text type
NXOpen.Annotations.TextType.Integer
.-------------------------------------
Getter Method
Signature
IntegerValue
Returns: Integer value Return type: int New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IntegerValue
Parameters: intValue (int) – New integer value New in version NX4.0.0.
License requirements: None.
RealValue¶
-
CustomSymbolTextData.
RealValue
¶ Returns or sets the real value.
Valid for the text type
NXOpen.Annotations.TextType.Real
.-------------------------------------
Getter Method
Signature
RealValue
Returns: Real value Return type: float New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RealValue
Parameters: realValue (float) – New real value New in version NX4.0.0.
License requirements: None.
StringValue¶
-
CustomSymbolTextData.
StringValue
¶ Returns the string value.
Valid for the text type
NXOpen.Annotations.TextType.Controlled
andNXOpen.Annotations.TextType.PartiallyControlled
.-------------------------------------
Getter Method
Signature
StringValue
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
TextType¶
-
CustomSymbolTextData.
TextType
¶ Returns the text type
-------------------------------------
Getter Method
Signature
TextType
Returns: Text type Return type: NXOpen.Annotations.TextType
New in version NX4.0.0.
License requirements: None.
Method Detail¶
Dispose¶
-
CustomSymbolTextData.
Dispose
¶ Frees the object from memory.
After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Signature
Dispose()
New in version NX4.0.0.
License requirements: None.
GetText¶
-
CustomSymbolTextData.
GetText
¶ Returns the text.
Valid for the text type
NXOpen.Annotations.TextType.Arbitrary
andNXOpen.Annotations.TextType.PartiallyControlled
.Signature
GetText()
Returns: List of lines Return type: list of str New in version NX4.0.0.
License requirements: None.
SetText¶
-
CustomSymbolTextData.
SetText
¶ Sets the text.
Valid for the text type
NXOpen.Annotations.TextType.Arbitrary
andNXOpen.Annotations.TextType.PartiallyControlled
.Signature
SetText(lines)
Parameters: lines (list of str) – List of lines New in version NX4.0.0.
License requirements: None.