NXOpen::Annotations::TableSectionStyleBuilder Class Reference

Represents a NXOpen::Annotations::TableSectionStyleBuilder . More...

Inheritance diagram for NXOpen::Annotations::TableSectionStyleBuilder:

Public Types
enum	AlignmentPositionType { AlignmentPositionTypeTopLeft, AlignmentPositionTypeTopRight, AlignmentPositionTypeBottomLeft, AlignmentPositionTypeBottomRight }
	Represents the alignment position type. More...
enum	ContinuationPropertyType {   ContinuationPropertyTypeLeft, ContinuationPropertyTypeRight, ContinuationPropertyTypeUp, ContinuationPropertyTypeDown,   ContinuationPropertyTypeNextSheet }
	Represents the section continuation property. More...
enum	DisplayContinuationNoteType { DisplayContinuationNoteTypeNone, DisplayContinuationNoteTypeAbove, DisplayContinuationNoteTypeBelow }
	Represents the display continuation note choices. More...
enum	LocationOfHeader { LocationOfHeaderAbove, LocationOfHeaderBelow, LocationOfHeaderNone }
	Represents the section header location choices. More...

Public Member Functions
NXOpen::Annotations::TableSectionStyleBuilder::AlignmentPositionType	AlignmentPosition ()
	Returns the alignment Position settings of the section Created in NX8.0.0. More...
bool	ApplyToAllSections ()
	Returns the apply to all sections flag that when set applies settings to all sections Created in NX9.0.0. More...
double	BorderOffset ()
	Returns the border offset value Created in NX8.0.0. More...
NXString	ContinuationNote ()
	Returns the continuation note flag setting Created in NX8.0.0. More...
NXOpen::Annotations::TableSectionStyleBuilder::ContinuationPropertyType	ContinuationProperty ()
	Returns the continuation property type Created in NX8.0.0. More...
double	ContinuationSpacing ()
	Returns the continuation spacing value between sections Created in NX8.0.0. More...
NXOpen::Annotations::TableSectionStyleBuilder::DisplayContinuationNoteType	DisplayContinuationNote ()
	Returns the display continuation note type Created in NX8.0.0. More...
bool	DoubleBorder ()
	Returns the double border flag setting Created in NX8.0.0. More...
NXOpen::Annotations::TableSectionStyleBuilder::LocationOfHeader	HeaderLocation ()
	Returns the value that represents the location of header on a section Created in NX8.0.0. More...
double	MaximumHeight ()
	Returns the value that represents the maximum height of the section Created in NX8.0.0. More...
void	SetAlignmentPosition (NXOpen::Annotations::TableSectionStyleBuilder::AlignmentPositionType alignmentPosition)
	Sets the alignment Position settings of the section Created in NX8.0.0. More...
void	SetApplyToAllSections (bool applyToAllSections)
	Sets the apply to all sections flag that when set applies settings to all sections Created in NX9.0.0. More...
void	SetBorderOffset (double borderOffset)
	Sets the border offset value Created in NX8.0.0. More...
void	SetContinuationNote (const NXString &continuationNote)
	Sets the continuation note flag setting Created in NX8.0.0. More...
void	SetContinuationNote (const char *continuationNote)
	Sets the continuation note flag setting Created in NX8.0.0. More...
void	SetContinuationProperty (NXOpen::Annotations::TableSectionStyleBuilder::ContinuationPropertyType continuationProperty)
	Sets the continuation property type Created in NX8.0.0. More...
void	SetContinuationSpacing (double spacing)
	Sets the continuation spacing value between sections Created in NX8.0.0. More...
void	SetDisplayContinuationNote (NXOpen::Annotations::TableSectionStyleBuilder::DisplayContinuationNoteType displayContinuationNote)
	Sets the display continuation note type Created in NX8.0.0. More...
void	SetDoubleBorder (bool doubleBorder)
	Sets the double border flag setting Created in NX8.0.0. More...
void	SetHeaderLocation (NXOpen::Annotations::TableSectionStyleBuilder::LocationOfHeader headerLocation)
	Sets the value that represents the location of header on a section Created in NX8.0.0. More...
void	SetMaximumHeight (double maximumHeight)
	Sets the value that represents the maximum height of the section Created in NX8.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 NXOpen::Annotations::TableSectionStyleBuilder .

This class queries and sets preferences for various symbol type annotations when creating or editing.

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::TableSectionStyleBuilder::AlignmentPositionType

Represents the alignment position type.

Enumerator
AlignmentPositionTypeTopLeft	Top Left.
AlignmentPositionTypeTopRight	Top Right.
AlignmentPositionTypeBottomLeft	Bottom Left.
AlignmentPositionTypeBottomRight	Bottom right.

enum NXOpen::Annotations::TableSectionStyleBuilder::ContinuationPropertyType

Represents the section continuation property.

Enumerator
ContinuationPropertyTypeLeft	Left.
ContinuationPropertyTypeRight	Right.
ContinuationPropertyTypeUp	Up.
ContinuationPropertyTypeDown	Down.
ContinuationPropertyTypeNextSheet	Next Sheet.

enum NXOpen::Annotations::TableSectionStyleBuilder::DisplayContinuationNoteType

Represents the display continuation note choices.

Enumerator
DisplayContinuationNoteTypeNone	None.
DisplayContinuationNoteTypeAbove	Above.
DisplayContinuationNoteTypeBelow	Below.

enum NXOpen::Annotations::TableSectionStyleBuilder::LocationOfHeader

Represents the section header location choices.

Enumerator
LocationOfHeaderAbove	Above.
LocationOfHeaderBelow	Below.
LocationOfHeaderNone	None.

Member Function Documentation

NXOpen::Annotations::TableSectionStyleBuilder::AlignmentPositionType NXOpen::Annotations::TableSectionStyleBuilder::AlignmentPosition

(

)

Returns the alignment Position settings of the section
Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::TableSectionStyleBuilder::ApplyToAllSections

(

)

Returns the apply to all sections flag that when set applies settings to all sections
Created in NX9.0.0.

License requirements : None

double NXOpen::Annotations::TableSectionStyleBuilder::BorderOffset

(

)

Returns the border offset value
Created in NX8.0.0.

License requirements : None

NXString NXOpen::Annotations::TableSectionStyleBuilder::ContinuationNote

(

)

Returns the continuation note flag setting
Created in NX8.0.0.

License requirements : None

NXOpen::Annotations::TableSectionStyleBuilder::ContinuationPropertyType NXOpen::Annotations::TableSectionStyleBuilder::ContinuationProperty

(

)

Returns the continuation property type
Created in NX8.0.0.

License requirements : None

double NXOpen::Annotations::TableSectionStyleBuilder::ContinuationSpacing

(

)

Returns the continuation spacing value between sections
Created in NX8.0.0.

License requirements : None

NXOpen::Annotations::TableSectionStyleBuilder::DisplayContinuationNoteType NXOpen::Annotations::TableSectionStyleBuilder::DisplayContinuationNote

(

)

Returns the display continuation note type
Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::TableSectionStyleBuilder::DoubleBorder

(

)

Returns the double border flag setting
Created in NX8.0.0.

License requirements : None

NXOpen::Annotations::TableSectionStyleBuilder::LocationOfHeader NXOpen::Annotations::TableSectionStyleBuilder::HeaderLocation

(

)

Returns the value that represents the location of header on a section
Created in NX8.0.0.

License requirements : None

double NXOpen::Annotations::TableSectionStyleBuilder::MaximumHeight

(

)

Returns the value that represents the maximum height of the section
Created in NX8.0.0.

License requirements : None

void NXOpen::Annotations::TableSectionStyleBuilder::SetAlignmentPosition

(

NXOpen::Annotations::TableSectionStyleBuilder::AlignmentPositionType

alignmentPosition

)

Sets the alignment Position settings of the section
Created in NX8.0.0.

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

Parameters

alignmentPosition

alignmentposition

void NXOpen::Annotations::TableSectionStyleBuilder::SetApplyToAllSections

(

bool

applyToAllSections

)

Sets the apply to all sections flag that when set applies settings to all sections
Created in NX9.0.0.

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

Parameters

applyToAllSections

applytoallsections

void NXOpen::Annotations::TableSectionStyleBuilder::SetBorderOffset

(

double

borderOffset

)

Sets the border offset value
Created in NX8.0.0.

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

Parameters

borderOffset

borderoffset

void NXOpen::Annotations::TableSectionStyleBuilder::SetContinuationNote

(

const NXString &

continuationNote

)

Sets the continuation note flag setting
Created in NX8.0.0.

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

Parameters

continuationNote

continuationnote

void NXOpen::Annotations::TableSectionStyleBuilder::SetContinuationNote

(

const char *

continuationNote

)

Sets the continuation note flag setting
Created in NX8.0.0.

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

Parameters

continuationNote

continuationnote

void NXOpen::Annotations::TableSectionStyleBuilder::SetContinuationProperty

(

NXOpen::Annotations::TableSectionStyleBuilder::ContinuationPropertyType

continuationProperty

)

Sets the continuation property type
Created in NX8.0.0.

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

Parameters

continuationProperty

continuationproperty

void NXOpen::Annotations::TableSectionStyleBuilder::SetContinuationSpacing

(

double

spacing

)

Sets the continuation spacing value between sections
Created in NX8.0.0.

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

Parameters

spacing

spacing

void NXOpen::Annotations::TableSectionStyleBuilder::SetDisplayContinuationNote

(

NXOpen::Annotations::TableSectionStyleBuilder::DisplayContinuationNoteType

displayContinuationNote

)

Sets the display continuation note type
Created in NX8.0.0.

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

Parameters

displayContinuationNote

displaycontinuationnote

void NXOpen::Annotations::TableSectionStyleBuilder::SetDoubleBorder

(

bool

doubleBorder

)

Sets the double border flag setting
Created in NX8.0.0.

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

Parameters

doubleBorder

doubleborder

void NXOpen::Annotations::TableSectionStyleBuilder::SetHeaderLocation

(

NXOpen::Annotations::TableSectionStyleBuilder::LocationOfHeader

headerLocation

)

Sets the value that represents the location of header on a section
Created in NX8.0.0.

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

Parameters

headerLocation

headerlocation

void NXOpen::Annotations::TableSectionStyleBuilder::SetMaximumHeight

(

double

maximumHeight

)

Sets the value that represents the maximum height of the section
Created in NX8.0.0.

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

Parameters

maximumHeight

maximumheight

virtual bool NXOpen::Annotations::TableSectionStyleBuilder::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_TableSectionStyleBuilder.hxx