NXOpen::Annotations::AppendedTextBuilder Class Reference

This class is used to set/access the appended text of a dimension
This is a sub-builder class and cannot be directly instantiated

Created in NX9.0.0. More...

Inheritance diagram for NXOpen::Annotations::AppendedTextBuilder:

Public Member Functions
std::vector< NXString >	GetAbove ()
	Gets the appended text above the annotation. More...
std::vector< NXString >	GetAfter ()
	Gets the appended text after the annotation. More...
std::vector< NXString >	GetBefore ()
	Gets the appended text before the annotation. More...
std::vector< NXString >	GetBelow ()
	Gets the appended text below the annotation. More...
void	SetAbove (std::vector< NXString > &lines)
	Sets the appended text above the annotation Created in NX9.0.0. More...
void	SetAfter (std::vector< NXString > &lines)
	Sets the appended text after the annotation Created in NX9.0.0. More...
void	SetBefore (std::vector< NXString > &lines)
	Sets the appended text before the annotation Created in NX9.0.0. More...
void	SetBelow (std::vector< NXString > &lines)
	Sets the appended text below the annotation Created in NX9.0.0. More...
void	SetUserDefinedSymbolAspectRatio (double aspectRatio)
	Sets the aspect ratio for user defined symbol Created in NX11.0.0. More...
void	SetUserDefinedSymbolHeight (double height)
	Sets the height for user defined symbol Created in NX11.0.0. More...
void	SetUserDefinedSymbolLength (double length)
	Sets the length for user defined symbol Created in NX11.0.0. More...
void	SetUserDefinedSymbolScale (double scale)
	Sets the scale for user defined symbol Created in NX11.0.0. More...
double	UserDefinedSymbolAspectRatio ()
	Returns the aspect ratio for user defined symbol Created in NX11.0.0. More...
double	UserDefinedSymbolHeight ()
	Returns the height for user defined symbol Created in NX11.0.0. More...
double	UserDefinedSymbolLength ()
	Returns the length for user defined symbol Created in NX11.0.0. More...
double	UserDefinedSymbolScale ()
	Returns the scale for user defined symbol Created in NX11.0.0. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

This class is used to set/access the appended text of a dimension
This is a sub-builder class and cannot be directly instantiated

Created in NX9.0.0.

Member Function Documentation

std::vector<NXString> NXOpen::Annotations::AppendedTextBuilder::GetAbove

(

)

Gets the appended text above the annotation.

Returns

List of lines
Created in NX9.0.0.

License requirements : None

std::vector<NXString> NXOpen::Annotations::AppendedTextBuilder::GetAfter

(

)

Gets the appended text after the annotation.

Returns

List of lines
Created in NX9.0.0.

License requirements : None

std::vector<NXString> NXOpen::Annotations::AppendedTextBuilder::GetBefore

(

)

Gets the appended text before the annotation.

Returns

List of lines
Created in NX9.0.0.

License requirements : None

std::vector<NXString> NXOpen::Annotations::AppendedTextBuilder::GetBelow

(

)

Gets the appended text below the annotation.

Returns

List of lines
Created in NX9.0.0.

License requirements : None

void NXOpen::Annotations::AppendedTextBuilder::SetAbove

(

std::vector< NXString > &

lines

)

Sets the appended text above the annotation
Created in NX9.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters

lines

List of new lines

void NXOpen::Annotations::AppendedTextBuilder::SetAfter

(

std::vector< NXString > &

lines

)

Sets the appended text after the annotation
Created in NX9.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters

lines

List of new lines

void NXOpen::Annotations::AppendedTextBuilder::SetBefore

(

std::vector< NXString > &

lines

)

Sets the appended text before the annotation
Created in NX9.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters

lines

List of new lines

void NXOpen::Annotations::AppendedTextBuilder::SetBelow

(

std::vector< NXString > &

lines

)

Sets the appended text below the annotation
Created in NX9.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters

lines

List of new lines

void NXOpen::Annotations::AppendedTextBuilder::SetUserDefinedSymbolAspectRatio

(

double

aspectRatio

)

Sets the aspect ratio for user defined symbol
Created in NX11.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters

aspectRatio

aspectratio

void NXOpen::Annotations::AppendedTextBuilder::SetUserDefinedSymbolHeight

(

double

height

)

Sets the height for user defined symbol
Created in NX11.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters

height

height

void NXOpen::Annotations::AppendedTextBuilder::SetUserDefinedSymbolLength

(

double

length

)

Sets the length for user defined symbol
Created in NX11.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters

length

length

void NXOpen::Annotations::AppendedTextBuilder::SetUserDefinedSymbolScale

(

double

scale

)

Sets the scale for user defined symbol
Created in NX11.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters

scale

scale

double NXOpen::Annotations::AppendedTextBuilder::UserDefinedSymbolAspectRatio

(

)

Returns the aspect ratio for user defined symbol
Created in NX11.0.0.

License requirements : None

double NXOpen::Annotations::AppendedTextBuilder::UserDefinedSymbolHeight

(

)

Returns the height for user defined symbol
Created in NX11.0.0.

License requirements : None

double NXOpen::Annotations::AppendedTextBuilder::UserDefinedSymbolLength

(

)

Returns the length for user defined symbol
Created in NX11.0.0.

License requirements : None

double NXOpen::Annotations::AppendedTextBuilder::UserDefinedSymbolScale

(

)

Returns the scale for user defined symbol
Created in NX11.0.0.

License requirements : None

virtual bool NXOpen::Annotations::AppendedTextBuilder::Validate ( )

virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

---

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

• Annotations_AppendedTextBuilder.hxx