CustomSymbolData Class¶
-
class
NXOpen.Annotations.
CustomSymbolData
¶ Bases:
NXOpen.TransientObject
Represents custom symbol data
New in version NX4.0.0.
Deprecated since version NX9.0.0: Use
Annotations.DraftingCustomSymbolBuilder
for Drafting Custom Symbol andAnnotations.PmiCustomSymbolBuilder
for PMI Custom Symbol objects.
Properties¶
Property | Description |
---|---|
Angle | Returns or sets the angle |
Scale | Returns or sets the scale |
ScaleExpression | Returns or sets the scale expression |
SymbolPreferencesOption | Returns or sets the symbol preferences option. |
TextPreferencesOption | Returns or sets the text preferences option. |
Methods¶
Method | Description |
---|---|
Dispose | Frees the object from memory. |
GetTextData | Return the text data @return List of text data objects |
SetTextData | Sets the text data |
Property Detail¶
Angle¶
-
CustomSymbolData.
Angle
¶ Returns or sets the angle
-------------------------------------
Getter Method
Signature
Angle()
Returns: Angle at which custom symbol is oriented Return type: float New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Angle(angle)
Parameters: angle (float) – New angle at which custom symbol will be oriented New in version NX4.0.0.
License requirements: None.
Scale¶
-
CustomSymbolData.
Scale
¶ Returns or sets the scale
-------------------------------------
Getter Method
Signature
Scale()
Returns: Scale Return type: float New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Scale(scale)
Parameters: scale (float) – New scale New in version NX4.0.0.
License requirements: None.
ScaleExpression¶
-
CustomSymbolData.
ScaleExpression
¶ Returns or sets the scale expression
-------------------------------------
Getter Method
Signature
ScaleExpression()
Returns: Scale expression Return type: NXOpen.Expression
New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ScaleExpression(scaleExpression)
Parameters: scaleExpression ( NXOpen.Expression
) – New scale expressionNew in version NX4.0.0.
License requirements: None.
SymbolPreferencesOption¶
-
CustomSymbolData.
SymbolPreferencesOption
¶ Returns or sets the symbol preferences option.
This option is only available when creating.
-------------------------------------
Getter Method
Signature
SymbolPreferencesOption()
Returns: Symbol preferences option Return type: NXOpen.Annotations.SymbolPreferencesOption
New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SymbolPreferencesOption(option)
Parameters: option ( NXOpen.Annotations.SymbolPreferencesOption
) – New symbol preferences optionNew in version NX4.0.0.
License requirements: None.
TextPreferencesOption¶
-
CustomSymbolData.
TextPreferencesOption
¶ Returns or sets the text preferences option.
This option is only available when creating.
-------------------------------------
Getter Method
Signature
TextPreferencesOption()
Returns: Text preferences option Return type: NXOpen.Annotations.TextPreferencesOption
New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TextPreferencesOption(option)
Parameters: option ( NXOpen.Annotations.TextPreferencesOption
) – New text preferences optionNew in version NX4.0.0.
License requirements: None.
Method Detail¶
Dispose¶
-
CustomSymbolData.
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.
GetTextData¶
-
CustomSymbolData.
GetTextData
¶ Return the text data
Signature
GetTextData()
Returns: List of text data objects Return type: list of NXOpen.Annotations.CustomSymbolTextData
New in version NX4.0.0.
License requirements: None.
SetTextData¶
-
CustomSymbolData.
SetTextData
¶ Sets the text data
Signature
SetTextData(data)
Parameters: data (list of NXOpen.Annotations.CustomSymbolTextData
) – List of text data objectsNew in version NX4.0.0.
License requirements: None.