LetteringPreferences Class¶
-
class
NXOpen.Annotations.
LetteringPreferences
¶ Bases:
NXOpen.TransientObject
Represents lettering preferences.
When setting the property, changes are not applied to object until the set method is called
New in version NX3.0.0.
Properties¶
Property | Description |
---|---|
AlignmentPosition | Returns or sets the align position |
Angle | Returns or sets the angle |
DimAppendedTextSpaceFactor | Returns or sets the dimension/appended text space factor |
DimDimLineSpaceFactor | Returns or sets the dimension/dimension line space factor |
DimToleranceTextSpaceFactor | Returns or sets the dimension/tolerance text space factor |
GdtFrameHeightFactor | Returns or sets the gdt frame height factor |
HorizTextJust | Returns or sets the horizontal text justification |
StackAboveSpaceFactor | Returns or sets the stack above spacing factor for space buffer above annotation in stack. |
StackAutospace | Returns or sets the flag indicating whether to automatically set the stack spacing to system derived values |
StackBelowSpaceFactor | Returns or sets the stack below spacing factor for space buffer below annotation in stack. |
StackHorizontalAlignment | Returns or sets the stack horizontal(left/right) alignment option |
StackInheritAssociatedObjects | Returns or sets the flag indicating whether to inherit the associated objects of a stack when an annotation is inserted into a stack. |
StackLeftSpaceFactor | Returns or sets the stack left spacing factor for space buffer left annotation in stack. |
StackRightSpaceFactor | Returns or sets the stack right spacing factor for space buffer right annotation in stack. |
StackVerticalAlignment | Returns or sets the stack vertical(above/below) alignment option |
Methods¶
Method | Description |
---|---|
Dispose | Frees the object from memory. |
GetAppendedText | Returns the appended text |
GetDimensionText | Returns the dimension text |
GetGeneralText | Returns the general text |
GetToleranceText | Returns the tolerance text |
SetAppendedText | Sets the appended text |
SetDimensionText | Sets the dimension text |
SetGeneralText | Sets the general text |
SetToleranceText | Sets the tolerance text |
Property Detail¶
AlignmentPosition¶
-
LetteringPreferences.
AlignmentPosition
¶ Returns or sets the align position
-------------------------------------
Getter Method
Signature
AlignmentPosition
Returns: Return type: NXOpen.Annotations.AlignmentPosition
New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AlignmentPosition
Parameters: alignPosition ( NXOpen.Annotations.AlignmentPosition
) –New in version NX3.0.0.
License requirements: None.
Angle¶
-
LetteringPreferences.
Angle
¶ Returns or sets the angle
-------------------------------------
Getter Method
Signature
Angle
Returns: Return type: float New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Angle
Parameters: angle (float) – New in version NX3.0.0.
License requirements: None.
DimAppendedTextSpaceFactor¶
-
LetteringPreferences.
DimAppendedTextSpaceFactor
¶ Returns or sets the dimension/appended text space factor
-------------------------------------
Getter Method
Signature
DimAppendedTextSpaceFactor
Returns: Return type: float New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimAppendedTextSpaceFactor
Parameters: dimAppTextSpaceFactor (float) – New in version NX3.0.0.
License requirements: None.
DimDimLineSpaceFactor¶
-
LetteringPreferences.
DimDimLineSpaceFactor
¶ Returns or sets the dimension/dimension line space factor
-------------------------------------
Getter Method
Signature
DimDimLineSpaceFactor
Returns: Return type: float New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimDimLineSpaceFactor
Parameters: dimDimLineSpaceFactor (float) – New in version NX3.0.0.
License requirements: None.
DimToleranceTextSpaceFactor¶
-
LetteringPreferences.
DimToleranceTextSpaceFactor
¶ Returns or sets the dimension/tolerance text space factor
-------------------------------------
Getter Method
Signature
DimToleranceTextSpaceFactor
Returns: Return type: float New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimToleranceTextSpaceFactor
Parameters: dimTolTextSpaceFactor (float) – New in version NX3.0.0.
License requirements: None.
GdtFrameHeightFactor¶
-
LetteringPreferences.
GdtFrameHeightFactor
¶ Returns or sets the gdt frame height factor
-------------------------------------
Getter Method
Signature
GdtFrameHeightFactor
Returns: Return type: float New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GdtFrameHeightFactor
Parameters: gdtFrameHeightFactor (float) – New in version NX3.0.0.
License requirements: None.
HorizTextJust¶
-
LetteringPreferences.
HorizTextJust
¶ Returns or sets the horizontal text justification
-------------------------------------
Getter Method
Signature
HorizTextJust
Returns: Return type: NXOpen.Annotations.TextJustification
New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HorizTextJust
Parameters: horizTextJust ( NXOpen.Annotations.TextJustification
) –New in version NX3.0.0.
License requirements: None.
StackAboveSpaceFactor¶
-
LetteringPreferences.
StackAboveSpaceFactor
¶ Returns or sets the stack above spacing factor for space buffer above annotation in stack.
-------------------------------------
Getter Method
Signature
StackAboveSpaceFactor
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackAboveSpaceFactor
Parameters: stackAboveSpaceFactor (float) – New in version NX5.0.0.
License requirements: None.
StackAutospace¶
-
LetteringPreferences.
StackAutospace
¶ Returns or sets the flag indicating whether to automatically set the stack spacing to system derived values
-------------------------------------
Getter Method
Signature
StackAutospace
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackAutospace
Parameters: stackAutospace (bool) – New in version NX6.0.0.
License requirements: None.
StackBelowSpaceFactor¶
-
LetteringPreferences.
StackBelowSpaceFactor
¶ Returns or sets the stack below spacing factor for space buffer below annotation in stack.
-------------------------------------
Getter Method
Signature
StackBelowSpaceFactor
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackBelowSpaceFactor
Parameters: stackBelowSpaceFactor (float) – New in version NX5.0.0.
License requirements: None.
StackHorizontalAlignment¶
-
LetteringPreferences.
StackHorizontalAlignment
¶ Returns or sets the stack horizontal(left/right) alignment option
-------------------------------------
Getter Method
Signature
StackHorizontalAlignment
Returns: Return type: NXOpen.Annotations.StackHorizontalAlignment
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackHorizontalAlignment
Parameters: horizontalAlignment ( NXOpen.Annotations.StackHorizontalAlignment
) –New in version NX5.0.0.
License requirements: None.
StackInheritAssociatedObjects¶
-
LetteringPreferences.
StackInheritAssociatedObjects
¶ Returns or sets the flag indicating whether to inherit the associated objects of a stack when an annotation is inserted into a stack.
-------------------------------------
Getter Method
Signature
StackInheritAssociatedObjects
Returns: Flag to whether inherit associated objects of stack Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackInheritAssociatedObjects
Parameters: stackInheritAssociatedObjects (bool) – Flag to whether inherit associated objects of stack New in version NX5.0.0.
License requirements: None.
StackLeftSpaceFactor¶
-
LetteringPreferences.
StackLeftSpaceFactor
¶ Returns or sets the stack left spacing factor for space buffer left annotation in stack.
-------------------------------------
Getter Method
Signature
StackLeftSpaceFactor
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackLeftSpaceFactor
Parameters: stackLeftSpaceFactor (float) – New in version NX5.0.0.
License requirements: None.
StackRightSpaceFactor¶
-
LetteringPreferences.
StackRightSpaceFactor
¶ Returns or sets the stack right spacing factor for space buffer right annotation in stack.
-------------------------------------
Getter Method
Signature
StackRightSpaceFactor
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackRightSpaceFactor
Parameters: stackRightSpaceFactor (float) – New in version NX5.0.0.
License requirements: None.
StackVerticalAlignment¶
-
LetteringPreferences.
StackVerticalAlignment
¶ Returns or sets the stack vertical(above/below) alignment option
-------------------------------------
Getter Method
Signature
StackVerticalAlignment
Returns: Return type: NXOpen.Annotations.StackVerticalAlignment
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackVerticalAlignment
Parameters: verticalAlignment ( NXOpen.Annotations.StackVerticalAlignment
) –New in version NX5.0.0.
License requirements: None.
Method Detail¶
Dispose¶
-
LetteringPreferences.
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.
GetAppendedText¶
-
LetteringPreferences.
GetAppendedText
¶ Returns the appended text
Signature
GetAppendedText()
Returns: Return type: NXOpen.Annotations.Lettering
New in version NX3.0.0.
License requirements: None.
GetDimensionText¶
-
LetteringPreferences.
GetDimensionText
¶ Returns the dimension text
Signature
GetDimensionText()
Returns: Return type: NXOpen.Annotations.Lettering
New in version NX3.0.0.
License requirements: None.
GetGeneralText¶
-
LetteringPreferences.
GetGeneralText
¶ Returns the general text
Signature
GetGeneralText()
Returns: Return type: NXOpen.Annotations.Lettering
New in version NX3.0.0.
License requirements: None.
GetToleranceText¶
-
LetteringPreferences.
GetToleranceText
¶ Returns the tolerance text
Signature
GetToleranceText()
Returns: Return type: NXOpen.Annotations.Lettering
New in version NX3.0.0.
License requirements: None.
SetAppendedText¶
-
LetteringPreferences.
SetAppendedText
¶ Sets the appended text
Signature
SetAppendedText(appendedText)
Parameters: appendedText ( NXOpen.Annotations.Lettering
) –New in version NX3.0.0.
License requirements: None.
SetDimensionText¶
-
LetteringPreferences.
SetDimensionText
¶ Sets the dimension text
Signature
SetDimensionText(dimensionText)
Parameters: dimensionText ( NXOpen.Annotations.Lettering
) –New in version NX3.0.0.
License requirements: None.
SetGeneralText¶
-
LetteringPreferences.
SetGeneralText
¶ Sets the general text
Signature
SetGeneralText(generalText)
Parameters: generalText ( NXOpen.Annotations.Lettering
) –New in version NX3.0.0.
License requirements: None.
SetToleranceText¶
-
LetteringPreferences.
SetToleranceText
¶ Sets the tolerance text
Signature
SetToleranceText(toleranceText)
Parameters: toleranceText ( NXOpen.Annotations.Lettering
) –New in version NX3.0.0.
License requirements: None.