UserSymbolPreferences Class

class NXOpen.Annotations.UserSymbolPreferences

Bases: NXOpen.TransientObject

Represents preferences related to user-defined symbols

New in version NX3.0.0.

Methods

Method Description
Dispose Frees the object from memory.
GetSize Gets the size preference
SetLengthAndHeight Sets the length and height
SetScaleAndAspectRatio Sets the scale and aspect ratio

Enumerations

UserSymbolPreferencesSizeType Enumeration Specifies whether length and height or scale and aspect ratio is used in specifying the size of the symbol

Method Detail

Dispose

UserSymbolPreferences.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 NX3.0.0.

License requirements: None.

GetSize

UserSymbolPreferences.GetSize

Gets the size preference

Signature GetSize()

Returns:a tuple
Return type:A tuple consisting of (sizeType, lengthOrScale, heightOrAspectRatio). sizeType is a NXOpen.Annotations.UserSymbolPreferencesSizeType. Specifies whether length and height or scale and aspect ratio is used lengthOrScale is a float. Length or scale heightOrAspectRatio is a float. Height or aspect ratio

New in version NX3.0.0.

License requirements: None.

SetLengthAndHeight

UserSymbolPreferences.SetLengthAndHeight

Sets the length and height

Signature SetLengthAndHeight(length, height)

Parameters:
  • length (float) –
  • height (float) –

New in version NX3.0.0.

License requirements: None.

SetScaleAndAspectRatio

UserSymbolPreferences.SetScaleAndAspectRatio

Sets the scale and aspect ratio

Signature SetScaleAndAspectRatio(scale, aspectRatio)

Parameters:
  • scale (float) –
  • aspectRatio (float) –

New in version NX3.0.0.

License requirements: None.