Represents a TextStyleBuilder. More...

Inheritance diagram for NXOpen::Diagramming::TextStyleBuilder:

Public Types
enum	TextAlignmentType { TextAlignmentTypeLeft, TextAlignmentTypeCenter, TextAlignmentTypeRight }
	Represents the option NXOpen::Diagramming::TextStyleBuilder::TextAlignment for a NXOpen::Diagramming::TextStyleBuilder . More...

enum	TextAutoFitType { TextAutoFitTypeNone, TextAutoFitTypeResizeOutline, TextAutoFitTypeShrinkText }
	Represents the option for a NXOpen::Diagramming::TextStyleBuilder . More...

Public Member Functions
void	SetTextAlignment (NXOpen::Diagramming::TextStyleBuilder::TextAlignmentType alignment)
	Sets the text alignment of the annotation Created in NX11.0.0. More...

void	SetTextAllowWrapping (bool allowWrapping)
	Sets the text allow wrapping Created in NX11.0.0. More...

void	SetTextAutoFit (NXOpen::Diagramming::TextStyleBuilder::TextAutoFitType autoFit)
	Sets the text auto fit Created in NX11.0.0. More...

void	SetTextHeight (double height)
	Sets the height of the annotation Created in NX11.0.0. More...

void	SetTextOverlined (bool overlined)
	Sets whether the text is overlined Created in NX11.0.0. More...

void	SetTextUnderlined (bool underlined)
	Sets whether the text is underlined Created in NX11.0.0. More...

NXOpen::Diagramming::TextStyleBuilder::TextAlignmentType	TextAlignment ()
	Returns the text alignment of the annotation Created in NX11.0.0. More...

bool	TextAllowWrapping ()
	Returns the text allow wrapping Created in NX11.0.0. More...

NXOpen::Diagramming::TextStyleBuilder::TextAutoFitType	TextAutoFit ()
	Returns the text auto fit Created in NX11.0.0. More...

NXOpen::TextColorFontWidthBuilder *	TextColorFontWidth ()
	Returns the text color font width Created in NX11.0.0. More...

double	TextHeight ()
	Returns the height of the annotation Created in NX11.0.0. More...

bool	TextOverlined ()
	Returns whether the text is overlined Created in NX11.0.0. More...

bool	TextUnderlined ()
	Returns whether the text is underlined 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

Represents a TextStyleBuilder.

This is a sub-builder class and cannot be directly instantiated

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Diagramming::TextStyleBuilder::TextAlignmentType

Represents the option NXOpen::Diagramming::TextStyleBuilder::TextAlignment for a NXOpen::Diagramming::TextStyleBuilder .

Created in NX11.0.0.

Enumerator
TextAlignmentTypeLeft	left
TextAlignmentTypeCenter	center
TextAlignmentTypeRight	right

enum NXOpen::Diagramming::TextStyleBuilder::TextAutoFitType

Represents the option for a NXOpen::Diagramming::TextStyleBuilder .

Created in NX11.0.0.

Enumerator
TextAutoFitTypeNone	none
TextAutoFitTypeResizeOutline	resize outline
TextAutoFitTypeShrinkText	shrink text

Member Function Documentation

void NXOpen::Diagramming::TextStyleBuilder::SetTextAlignment ( NXOpen::Diagramming::TextStyleBuilder::TextAlignmentType alignment )

Sets the text alignment of the annotation
Created in NX11.0.0.

License requirements : None

Parameters

alignment alignment

void NXOpen::Diagramming::TextStyleBuilder::SetTextAllowWrapping ( bool allowWrapping )

Sets the text allow wrapping
Created in NX11.0.0.

License requirements : None

Parameters

allowWrapping allowwrapping

void NXOpen::Diagramming::TextStyleBuilder::SetTextAutoFit ( NXOpen::Diagramming::TextStyleBuilder::TextAutoFitType autoFit )

Sets the text auto fit
Created in NX11.0.0.

License requirements : None

Parameters

autoFit autofit

void NXOpen::Diagramming::TextStyleBuilder::SetTextHeight ( double height )

Sets the height of the annotation
Created in NX11.0.0.

License requirements : None

Parameters

height height

void NXOpen::Diagramming::TextStyleBuilder::SetTextOverlined ( bool overlined )

Sets whether the text is overlined
Created in NX11.0.0.

License requirements : None

Parameters

overlined overlined

void NXOpen::Diagramming::TextStyleBuilder::SetTextUnderlined ( bool underlined )

Sets whether the text is underlined
Created in NX11.0.0.

License requirements : None

Parameters

underlined underlined

NXOpen::Diagramming::TextStyleBuilder::TextAlignmentType NXOpen::Diagramming::TextStyleBuilder::TextAlignment ( )

Returns the text alignment of the annotation
Created in NX11.0.0.

License requirements : None

bool NXOpen::Diagramming::TextStyleBuilder::TextAllowWrapping ( )

Returns the text allow wrapping
Created in NX11.0.0.

License requirements : None

NXOpen::Diagramming::TextStyleBuilder::TextAutoFitType NXOpen::Diagramming::TextStyleBuilder::TextAutoFit ( )

Returns the text auto fit
Created in NX11.0.0.

License requirements : None

NXOpen::TextColorFontWidthBuilder* NXOpen::Diagramming::TextStyleBuilder::TextColorFontWidth ( )

Returns the text color font width
Created in NX11.0.0.

License requirements : None

double NXOpen::Diagramming::TextStyleBuilder::TextHeight ( )

Returns the height of the annotation
Created in NX11.0.0.

License requirements : None

bool NXOpen::Diagramming::TextStyleBuilder::TextOverlined ( )

Returns whether the text is overlined
Created in NX11.0.0.

License requirements : None

bool NXOpen::Diagramming::TextStyleBuilder::TextUnderlined ( )

Returns whether the text is underlined
Created in NX11.0.0.

License requirements : None

virtual bool NXOpen::Diagramming::TextStyleBuilder::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:

Diagramming_TextStyleBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation