NXOpen::Annotations::LetteringPreferences Class Reference

Represents lettering preferences. More...

Inheritance diagram for NXOpen::Annotations::LetteringPreferences:

Public Member Functions
NXOpen::Annotations::AlignmentPosition	AlignmentPosition ()
	Returns the align position Created in NX3.0.0. More...
double	Angle ()
	Returns the angle Created in NX3.0.0. More...
double	DimAppendedTextSpaceFactor ()
	Returns the dimension/appended text space factor Created in NX3.0.0. More...
double	DimDimLineSpaceFactor ()
	Returns the dimension/dimension line space factor Created in NX3.0.0. More...
double	DimToleranceTextSpaceFactor ()
	Returns the dimension/tolerance text space factor Created in NX3.0.0. More...
double	GdtFrameHeightFactor ()
	Returns the gdt frame height factor Created in NX3.0.0. More...
NXOpen::Annotations::Lettering	GetAppendedText ()
	Returns the appended text. More...
NXOpen::Annotations::Lettering	GetDimensionText ()
	Returns the dimension text. More...
NXOpen::Annotations::Lettering	GetGeneralText ()
	Returns the general text. More...
NXOpen::Annotations::Lettering	GetToleranceText ()
	Returns the tolerance text. More...
NXOpen::Annotations::TextJustification	HorizTextJust ()
	Returns the horizontal text justification Created in NX3.0.0. More...
void	SetAlignmentPosition (NXOpen::Annotations::AlignmentPosition alignPosition)
	Sets the align position Created in NX3.0.0. More...
void	SetAngle (double angle)
	Sets the angle Created in NX3.0.0. More...
void	SetAppendedText (const NXOpen::Annotations::Lettering &appendedText)
	Sets the appended text Created in NX3.0.0. More...
void	SetDimAppendedTextSpaceFactor (double dimAppTextSpaceFactor)
	Sets the dimension/appended text space factor Created in NX3.0.0. More...
void	SetDimDimLineSpaceFactor (double dimDimLineSpaceFactor)
	Sets the dimension/dimension line space factor Created in NX3.0.0. More...
void	SetDimensionText (const NXOpen::Annotations::Lettering &dimensionText)
	Sets the dimension text Created in NX3.0.0. More...
void	SetDimToleranceTextSpaceFactor (double dimTolTextSpaceFactor)
	Sets the dimension/tolerance text space factor Created in NX3.0.0. More...
void	SetGdtFrameHeightFactor (double gdtFrameHeightFactor)
	Sets the gdt frame height factor Created in NX3.0.0. More...
void	SetGeneralText (const NXOpen::Annotations::Lettering &generalText)
	Sets the general text Created in NX3.0.0. More...
void	SetHorizTextJust (NXOpen::Annotations::TextJustification horizTextJust)
	Sets the horizontal text justification Created in NX3.0.0. More...
void	SetStackAboveSpaceFactor (double stackAboveSpaceFactor)
	Sets the stack above spacing factor for space buffer above annotation in stack. More...
void	SetStackAutospace (bool stackAutospace)
	Sets the flag indicating whether to automatically set the stack spacing to system derived values Created in NX6.0.0. More...
void	SetStackBelowSpaceFactor (double stackBelowSpaceFactor)
	Sets the stack below spacing factor for space buffer below annotation in stack. More...
void	SetStackHorizontalAlignment (NXOpen::Annotations::StackHorizontalAlignment horizontalAlignment)
	Sets the stack horizontal(left/right) alignment option Created in NX5.0.0. More...
void	SetStackInheritAssociatedObjects (bool stackInheritAssociatedObjects)
	Sets the flag indicating whether to inherit the associated objects of a stack when an annotation is inserted into a stack. More...
void	SetStackLeftSpaceFactor (double stackLeftSpaceFactor)
	Sets the stack left spacing factor for space buffer left annotation in stack. More...
void	SetStackRightSpaceFactor (double stackRightSpaceFactor)
	Sets the stack right spacing factor for space buffer right annotation in stack. More...
void	SetStackVerticalAlignment (NXOpen::Annotations::StackVerticalAlignment verticalAlignment)
	Sets the stack vertical(above/below) alignment option Created in NX5.0.0. More...
void	SetToleranceText (const NXOpen::Annotations::Lettering &toleranceText)
	Sets the tolerance text Created in NX3.0.0. More...
double	StackAboveSpaceFactor ()
	Returns the stack above spacing factor for space buffer above annotation in stack. More...
bool	StackAutospace ()
	Returns the flag indicating whether to automatically set the stack spacing to system derived values Created in NX6.0.0. More...
double	StackBelowSpaceFactor ()
	Returns the stack below spacing factor for space buffer below annotation in stack. More...
NXOpen::Annotations::StackHorizontalAlignment	StackHorizontalAlignment ()
	Returns the stack horizontal(left/right) alignment option Created in NX5.0.0. More...
bool	StackInheritAssociatedObjects ()
	Returns the flag indicating whether to inherit the associated objects of a stack when an annotation is inserted into a stack. More...
double	StackLeftSpaceFactor ()
	Returns the stack left spacing factor for space buffer left annotation in stack. More...
double	StackRightSpaceFactor ()
	Returns the stack right spacing factor for space buffer right annotation in stack. More...
NXOpen::Annotations::StackVerticalAlignment	StackVerticalAlignment ()
	Returns the stack vertical(above/below) alignment option Created in NX5.0.0. More...
virtual	~LetteringPreferences ()
	Frees the object from memory. More...
Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object. More...

Detailed Description

Represents lettering preferences.

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

Created in NX3.0.0.

Constructor & Destructor Documentation

virtual NXOpen::Annotations::LetteringPreferences::~LetteringPreferences ( )

virtual

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.
Created in NX3.0.0.

License requirements : None

Member Function Documentation

NXOpen::Annotations::AlignmentPosition NXOpen::Annotations::LetteringPreferences::AlignmentPosition

(

)

Returns the align position
Created in NX3.0.0.

License requirements : None

double NXOpen::Annotations::LetteringPreferences::Angle

(

)

Returns the angle
Created in NX3.0.0.

License requirements : None

double NXOpen::Annotations::LetteringPreferences::DimAppendedTextSpaceFactor

(

)

Returns the dimension/appended text space factor
Created in NX3.0.0.

License requirements : None

double NXOpen::Annotations::LetteringPreferences::DimDimLineSpaceFactor

(

)

Returns the dimension/dimension line space factor
Created in NX3.0.0.

License requirements : None

double NXOpen::Annotations::LetteringPreferences::DimToleranceTextSpaceFactor

(

)

Returns the dimension/tolerance text space factor
Created in NX3.0.0.

License requirements : None

double NXOpen::Annotations::LetteringPreferences::GdtFrameHeightFactor

(

)

Returns the gdt frame height factor
Created in NX3.0.0.

License requirements : None

NXOpen::Annotations::Lettering NXOpen::Annotations::LetteringPreferences::GetAppendedText

(

)

Returns the appended text.

Returns

Created in NX3.0.0.

License requirements : None

NXOpen::Annotations::Lettering NXOpen::Annotations::LetteringPreferences::GetDimensionText

(

)

Returns the dimension text.

Returns

Created in NX3.0.0.

License requirements : None

NXOpen::Annotations::Lettering NXOpen::Annotations::LetteringPreferences::GetGeneralText

(

)

Returns the general text.

Returns

Created in NX3.0.0.

License requirements : None

NXOpen::Annotations::Lettering NXOpen::Annotations::LetteringPreferences::GetToleranceText

(

)

Returns the tolerance text.

Returns

Created in NX3.0.0.

License requirements : None

NXOpen::Annotations::TextJustification NXOpen::Annotations::LetteringPreferences::HorizTextJust

(

)

Returns the horizontal text justification
Created in NX3.0.0.

License requirements : None

void NXOpen::Annotations::LetteringPreferences::SetAlignmentPosition

(

NXOpen::Annotations::AlignmentPosition

alignPosition

)

Sets the align position
Created in NX3.0.0.

License requirements : None

Parameters

alignPosition

align position

void NXOpen::Annotations::LetteringPreferences::SetAngle

(

double

angle

)

Sets the angle
Created in NX3.0.0.

License requirements : None

Parameters

angle

angle

void NXOpen::Annotations::LetteringPreferences::SetAppendedText

(

const NXOpen::Annotations::Lettering &

appendedText

)

Sets the appended text
Created in NX3.0.0.

License requirements : None

Parameters

appendedText

appended text

void NXOpen::Annotations::LetteringPreferences::SetDimAppendedTextSpaceFactor

(

double

dimAppTextSpaceFactor

)

Sets the dimension/appended text space factor
Created in NX3.0.0.

License requirements : None

Parameters

dimAppTextSpaceFactor

dim app text space factor

void NXOpen::Annotations::LetteringPreferences::SetDimDimLineSpaceFactor

(

double

dimDimLineSpaceFactor

)

Sets the dimension/dimension line space factor
Created in NX3.0.0.

License requirements : None

Parameters

dimDimLineSpaceFactor

dim dim line space factor

void NXOpen::Annotations::LetteringPreferences::SetDimensionText

(

const NXOpen::Annotations::Lettering &

dimensionText

)

Sets the dimension text
Created in NX3.0.0.

License requirements : None

Parameters

dimensionText

dimension text

void NXOpen::Annotations::LetteringPreferences::SetDimToleranceTextSpaceFactor

(

double

dimTolTextSpaceFactor

)

Sets the dimension/tolerance text space factor
Created in NX3.0.0.

License requirements : None

Parameters

dimTolTextSpaceFactor

dim tol text space factor

void NXOpen::Annotations::LetteringPreferences::SetGdtFrameHeightFactor

(

double

gdtFrameHeightFactor

)

Sets the gdt frame height factor
Created in NX3.0.0.

License requirements : None

Parameters

gdtFrameHeightFactor

gdt frame height factor

void NXOpen::Annotations::LetteringPreferences::SetGeneralText

(

const NXOpen::Annotations::Lettering &

generalText

)

Sets the general text
Created in NX3.0.0.

License requirements : None

Parameters

generalText

general text

void NXOpen::Annotations::LetteringPreferences::SetHorizTextJust

(

NXOpen::Annotations::TextJustification

horizTextJust

)

Sets the horizontal text justification
Created in NX3.0.0.

License requirements : None

Parameters

horizTextJust

horiz text just

void NXOpen::Annotations::LetteringPreferences::SetStackAboveSpaceFactor

(

double

stackAboveSpaceFactor

)

Sets the stack above spacing factor for space buffer above annotation in stack.

Created in NX5.0.0.

License requirements : None

Parameters

stackAboveSpaceFactor

stack above space factor

void NXOpen::Annotations::LetteringPreferences::SetStackAutospace

(

bool

stackAutospace

)

Sets the flag indicating whether to automatically set the stack spacing to system derived values
Created in NX6.0.0.

License requirements : None

Parameters

stackAutospace

stack autospace

void NXOpen::Annotations::LetteringPreferences::SetStackBelowSpaceFactor

(

double

stackBelowSpaceFactor

)

Sets the stack below spacing factor for space buffer below annotation in stack.

Created in NX5.0.0.

License requirements : None

Parameters

stackBelowSpaceFactor

stack below space factor

void NXOpen::Annotations::LetteringPreferences::SetStackHorizontalAlignment

(

NXOpen::Annotations::StackHorizontalAlignment

horizontalAlignment

)

Sets the stack horizontal(left/right) alignment option
Created in NX5.0.0.

License requirements : None

Parameters

horizontalAlignment

horizontal alignment

void NXOpen::Annotations::LetteringPreferences::SetStackInheritAssociatedObjects

(

bool

stackInheritAssociatedObjects

)

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

Created in NX5.0.0.

License requirements : None

Parameters

stackInheritAssociatedObjects

Flag to whether inherit associated objects of stack

void NXOpen::Annotations::LetteringPreferences::SetStackLeftSpaceFactor

(

double

stackLeftSpaceFactor

)

Sets the stack left spacing factor for space buffer left annotation in stack.

Created in NX5.0.0.

License requirements : None

Parameters

stackLeftSpaceFactor

stack left space factor

void NXOpen::Annotations::LetteringPreferences::SetStackRightSpaceFactor

(

double

stackRightSpaceFactor

)

Sets the stack right spacing factor for space buffer right annotation in stack.

Created in NX5.0.0.

License requirements : None

Parameters

stackRightSpaceFactor

stack right space factor

void NXOpen::Annotations::LetteringPreferences::SetStackVerticalAlignment

(

NXOpen::Annotations::StackVerticalAlignment

verticalAlignment

)

Sets the stack vertical(above/below) alignment option
Created in NX5.0.0.

License requirements : None

Parameters

verticalAlignment

vertical alignment

void NXOpen::Annotations::LetteringPreferences::SetToleranceText

(

const NXOpen::Annotations::Lettering &

toleranceText

)

Sets the tolerance text
Created in NX3.0.0.

License requirements : None

Parameters

toleranceText

tolerance text

double NXOpen::Annotations::LetteringPreferences::StackAboveSpaceFactor

(

)

Returns the stack above spacing factor for space buffer above annotation in stack.

Created in NX5.0.0.

License requirements : None

bool NXOpen::Annotations::LetteringPreferences::StackAutospace

(

)

Returns the flag indicating whether to automatically set the stack spacing to system derived values
Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::LetteringPreferences::StackBelowSpaceFactor

(

)

Returns the stack below spacing factor for space buffer below annotation in stack.

Created in NX5.0.0.

License requirements : None

NXOpen::Annotations::StackHorizontalAlignment NXOpen::Annotations::LetteringPreferences::StackHorizontalAlignment

(

)

Returns the stack horizontal(left/right) alignment option
Created in NX5.0.0.

License requirements : None

bool NXOpen::Annotations::LetteringPreferences::StackInheritAssociatedObjects

(

)

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

Created in NX5.0.0.

License requirements : None

double NXOpen::Annotations::LetteringPreferences::StackLeftSpaceFactor

(

)

Returns the stack left spacing factor for space buffer left annotation in stack.

Created in NX5.0.0.

License requirements : None

double NXOpen::Annotations::LetteringPreferences::StackRightSpaceFactor

(

)

Returns the stack right spacing factor for space buffer right annotation in stack.

Created in NX5.0.0.

License requirements : None

NXOpen::Annotations::StackVerticalAlignment NXOpen::Annotations::LetteringPreferences::StackVerticalAlignment

(

)

Returns the stack vertical(above/below) alignment option
Created in NX5.0.0.

License requirements : None

---

The documentation for this class was generated from the following file:

• Annotations_LetteringPreferences.hxx