nxopen.annotations

Interface LetteringPreferences

All Superinterfaces:

Remote, TransientObject

public interface LetteringPreferences
extends TransientObject

Represents lettering preferences.
When setting the property, changes are not applied to object until the set method is called

Created in NX3.0.0

Method Summary

Modifier and Type	Method and Description
AlignmentPosition	alignmentPosition() Returns the align position License requirements: None.
double	angle() Returns the angle License requirements: None.
double	dimAppendedTextSpaceFactor() Returns the dimension/appended text space factor License requirements: None.
double	dimDimLineSpaceFactor() Returns the dimension/dimension line space factor License requirements: None.
double	dimToleranceTextSpaceFactor() Returns the dimension/tolerance text space factor License requirements: None.
double	gdtFrameHeightFactor() Returns the gdt frame height factor License requirements: None.
Lettering	getAppendedText() Returns the appended text License requirements: None.
Lettering	getDimensionText() Returns the dimension text License requirements: None.
Lettering	getGeneralText() Returns the general text License requirements: None.
Lettering	getToleranceText() Returns the tolerance text License requirements: None.
TextJustification	horizTextJust() Returns the horizontal text justification License requirements: None.
void	setAlignmentPosition(AlignmentPosition alignPosition) Sets the align position License requirements: None.
void	setAngle(double angle) Sets the angle License requirements: None.
void	setAppendedText(Lettering appendedText) Sets the appended text License requirements: None.
void	setDimAppendedTextSpaceFactor(double dimAppTextSpaceFactor) Sets the dimension/appended text space factor License requirements: None.
void	setDimDimLineSpaceFactor(double dimDimLineSpaceFactor) Sets the dimension/dimension line space factor License requirements: None.
void	setDimensionText(Lettering dimensionText) Sets the dimension text License requirements: None.
void	setDimToleranceTextSpaceFactor(double dimTolTextSpaceFactor) Sets the dimension/tolerance text space factor License requirements: None.
void	setGdtFrameHeightFactor(double gdtFrameHeightFactor) Sets the gdt frame height factor License requirements: None.
void	setGeneralText(Lettering generalText) Sets the general text License requirements: None.
void	setHorizTextJust(TextJustification horizTextJust) Sets the horizontal text justification License requirements: None.
void	setStackAboveSpaceFactor(double stackAboveSpaceFactor) Sets the stack above spacing factor for space buffer above annotation in stack.
void	setStackAutospace(boolean stackAutospace) Sets the flag indicating whether to automatically set the stack spacing to system derived values License requirements: None.
void	setStackBelowSpaceFactor(double stackBelowSpaceFactor) Sets the stack below spacing factor for space buffer below annotation in stack.
void	setStackHorizontalAlignment(StackHorizontalAlignment horizontalAlignment) Sets the stack horizontal(left/right) alignment option License requirements: None.
void	setStackInheritAssociatedObjects(boolean stackInheritAssociatedObjects) Sets the flag indicating whether to inherit the associated objects of a stack when an annotation is inserted into a stack.
void	setStackLeftSpaceFactor(double stackLeftSpaceFactor) Sets the stack left spacing factor for space buffer left annotation in stack.
void	setStackRightSpaceFactor(double stackRightSpaceFactor) Sets the stack right spacing factor for space buffer right annotation in stack.
void	setStackVerticalAlignment(StackVerticalAlignment verticalAlignment) Sets the stack vertical(above/below) alignment option License requirements: None.
void	setToleranceText(Lettering toleranceText) Sets the tolerance text License requirements: None.
double	stackAboveSpaceFactor() Returns the stack above spacing factor for space buffer above annotation in stack.
boolean	stackAutospace() Returns the flag indicating whether to automatically set the stack spacing to system derived values License requirements: None.
double	stackBelowSpaceFactor() Returns the stack below spacing factor for space buffer below annotation in stack.
StackHorizontalAlignment	stackHorizontalAlignment() Returns the stack horizontal(left/right) alignment option License requirements: None.
boolean	stackInheritAssociatedObjects() Returns the flag indicating whether to inherit the associated objects of a stack when an annotation is inserted into a stack.
double	stackLeftSpaceFactor() Returns the stack left spacing factor for space buffer left annotation in stack.
double	stackRightSpaceFactor() Returns the stack right spacing factor for space buffer right annotation in stack.
StackVerticalAlignment	stackVerticalAlignment() Returns the stack vertical(above/below) alignment option License requirements: None.

Methods inherited from interface nxopen.TransientObject

_value, dispose, printTestData, printTestData

Method Detail

alignmentPosition

AlignmentPosition alignmentPosition()
                             throws NXException,
                                    RemoteException

Returns the align position
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setAlignmentPosition

void setAlignmentPosition(AlignmentPosition alignPosition)
                   throws NXException,
                          RemoteException

Sets the align position
License requirements: None.

Created in NX3.0.0

Parameters:

alignPosition -

Throws:

NXException

RemoteException

horizTextJust

TextJustification horizTextJust()
                         throws NXException,
                                RemoteException

Returns the horizontal text justification
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setHorizTextJust

void setHorizTextJust(TextJustification horizTextJust)
               throws NXException,
                      RemoteException

Sets the horizontal text justification
License requirements: None.

Created in NX3.0.0

Parameters:

horizTextJust -

Throws:

NXException

RemoteException

gdtFrameHeightFactor

double gdtFrameHeightFactor()
                     throws NXException,
                            RemoteException

Returns the gdt frame height factor
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setGdtFrameHeightFactor

void setGdtFrameHeightFactor(double gdtFrameHeightFactor)
                      throws NXException,
                             RemoteException

Sets the gdt frame height factor
License requirements: None.

Created in NX3.0.0

Parameters:

gdtFrameHeightFactor -

Throws:

NXException

RemoteException

angle

double angle()
      throws NXException,
             RemoteException

Returns the angle
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setAngle

void setAngle(double angle)
       throws NXException,
              RemoteException

Sets the angle
License requirements: None.

Created in NX3.0.0

Parameters:

angle -

Throws:

NXException

RemoteException

dimDimLineSpaceFactor

double dimDimLineSpaceFactor()
                      throws NXException,
                             RemoteException

Returns the dimension/dimension line space factor
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setDimDimLineSpaceFactor

void setDimDimLineSpaceFactor(double dimDimLineSpaceFactor)
                       throws NXException,
                              RemoteException

Sets the dimension/dimension line space factor
License requirements: None.

Created in NX3.0.0

Parameters:

dimDimLineSpaceFactor -

Throws:

NXException

RemoteException

dimAppendedTextSpaceFactor

double dimAppendedTextSpaceFactor()
                           throws NXException,
                                  RemoteException

Returns the dimension/appended text space factor
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setDimAppendedTextSpaceFactor

void setDimAppendedTextSpaceFactor(double dimAppTextSpaceFactor)
                            throws NXException,
                                   RemoteException

Sets the dimension/appended text space factor
License requirements: None.

Created in NX3.0.0

Parameters:

dimAppTextSpaceFactor -

Throws:

NXException

RemoteException

dimToleranceTextSpaceFactor

double dimToleranceTextSpaceFactor()
                            throws NXException,
                                   RemoteException

Returns the dimension/tolerance text space factor
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setDimToleranceTextSpaceFactor

void setDimToleranceTextSpaceFactor(double dimTolTextSpaceFactor)
                             throws NXException,
                                    RemoteException

Sets the dimension/tolerance text space factor
License requirements: None.

Created in NX3.0.0

Parameters:

dimTolTextSpaceFactor -

Throws:

NXException

RemoteException

getDimensionText

Lettering getDimensionText()
                    throws NXException,
                           RemoteException

Returns the dimension text
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setDimensionText

void setDimensionText(Lettering dimensionText)
               throws NXException,
                      RemoteException

Sets the dimension text
License requirements: None.

Created in NX3.0.0

Parameters:

dimensionText -

Throws:

NXException

RemoteException

getAppendedText

Lettering getAppendedText()
                   throws NXException,
                          RemoteException

Returns the appended text
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setAppendedText

void setAppendedText(Lettering appendedText)
              throws NXException,
                     RemoteException

Sets the appended text
License requirements: None.

Created in NX3.0.0

Parameters:

appendedText -

Throws:

NXException

RemoteException

getToleranceText

Lettering getToleranceText()
                    throws NXException,
                           RemoteException

Returns the tolerance text
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setToleranceText

void setToleranceText(Lettering toleranceText)
               throws NXException,
                      RemoteException

Sets the tolerance text
License requirements: None.

Created in NX3.0.0

Parameters:

toleranceText -

Throws:

NXException

RemoteException

getGeneralText

Lettering getGeneralText()
                  throws NXException,
                         RemoteException

Returns the general text
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setGeneralText

void setGeneralText(Lettering generalText)
             throws NXException,
                    RemoteException

Sets the general text
License requirements: None.

Created in NX3.0.0

Parameters:

generalText -

Throws:

NXException

RemoteException

stackVerticalAlignment

StackVerticalAlignment stackVerticalAlignment()
                                       throws NXException,
                                              RemoteException

Returns the stack vertical(above/below) alignment option
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setStackVerticalAlignment

void setStackVerticalAlignment(StackVerticalAlignment verticalAlignment)
                        throws NXException,
                               RemoteException

Sets the stack vertical(above/below) alignment option
License requirements: None.

Created in NX5.0.0

Parameters:

verticalAlignment -

Throws:

NXException

RemoteException

stackHorizontalAlignment

StackHorizontalAlignment stackHorizontalAlignment()
                                           throws NXException,
                                                  RemoteException

Returns the stack horizontal(left/right) alignment option
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setStackHorizontalAlignment

void setStackHorizontalAlignment(StackHorizontalAlignment horizontalAlignment)
                          throws NXException,
                                 RemoteException

Sets the stack horizontal(left/right) alignment option
License requirements: None.

Created in NX5.0.0

Parameters:

horizontalAlignment -

Throws:

NXException

RemoteException

stackAboveSpaceFactor

double stackAboveSpaceFactor()
                      throws NXException,
                             RemoteException

Returns the stack above spacing factor for space buffer above annotation in stack.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setStackAboveSpaceFactor

void setStackAboveSpaceFactor(double stackAboveSpaceFactor)
                       throws NXException,
                              RemoteException

Sets the stack above spacing factor for space buffer above annotation in stack.
License requirements: None.

Created in NX5.0.0

Parameters:

stackAboveSpaceFactor -

Throws:

NXException

RemoteException

stackBelowSpaceFactor

double stackBelowSpaceFactor()
                      throws NXException,
                             RemoteException

Returns the stack below spacing factor for space buffer below annotation in stack.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setStackBelowSpaceFactor

void setStackBelowSpaceFactor(double stackBelowSpaceFactor)
                       throws NXException,
                              RemoteException

Sets the stack below spacing factor for space buffer below annotation in stack.
License requirements: None.

Created in NX5.0.0

Parameters:

stackBelowSpaceFactor -

Throws:

NXException

RemoteException

stackLeftSpaceFactor

double stackLeftSpaceFactor()
                     throws NXException,
                            RemoteException

Returns the stack left spacing factor for space buffer left annotation in stack.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setStackLeftSpaceFactor

void setStackLeftSpaceFactor(double stackLeftSpaceFactor)
                      throws NXException,
                             RemoteException

Sets the stack left spacing factor for space buffer left annotation in stack.
License requirements: None.

Created in NX5.0.0

Parameters:

stackLeftSpaceFactor -

Throws:

NXException

RemoteException

stackRightSpaceFactor

double stackRightSpaceFactor()
                      throws NXException,
                             RemoteException

Returns the stack right spacing factor for space buffer right annotation in stack.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setStackRightSpaceFactor

void setStackRightSpaceFactor(double stackRightSpaceFactor)
                       throws NXException,
                              RemoteException

Sets the stack right spacing factor for space buffer right annotation in stack.
License requirements: None.

Created in NX5.0.0

Parameters:

stackRightSpaceFactor -

Throws:

NXException

RemoteException

stackInheritAssociatedObjects

boolean stackInheritAssociatedObjects()
                               throws NXException,
                                      RemoteException

Returns the flag indicating whether to inherit the associated objects of a stack when an annotation is inserted into a stack.
License requirements: None.

Created in NX5.0.0

Returns:

Flag to whether inherit associated objects of stack

Throws:

NXException

RemoteException

setStackInheritAssociatedObjects

void setStackInheritAssociatedObjects(boolean stackInheritAssociatedObjects)
                               throws NXException,
                                      RemoteException

Sets the flag indicating whether to inherit the associated objects of a stack when an annotation is inserted into a stack.
License requirements: None.

Created in NX5.0.0

Parameters:

stackInheritAssociatedObjects - Flag to whether inherit associated objects of stack

Throws:

NXException

RemoteException

stackAutospace

boolean stackAutospace()
                throws NXException,
                       RemoteException

Returns the flag indicating whether to automatically set the stack spacing to system derived values
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setStackAutospace

void setStackAutospace(boolean stackAutospace)
                throws NXException,
                       RemoteException

Sets the flag indicating whether to automatically set the stack spacing to system derived values
License requirements: None.

Created in NX6.0.0

Parameters:

stackAutospace -

Throws:

NXException

RemoteException