NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Annotations::TableSectionStyleBuilder Class Reference

Represents a Annotations::TableSectionStyleBuilder . More...

Inheritance diagram for NXOpen::Annotations::TableSectionStyleBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

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

Public Member Functions

NXOpen::Annotations::TableSectionStyleBuilder::AlignmentPositionType AlignmentPosition ()
 Returns the alignment Position of the section
Created in NX8.0.0.
double BorderOffset ()
 Returns the border offset
Created in NX8.0.0.
NXString ContinuationNote ()
 Returns the continuation note
Created in NX8.0.0.
NXOpen::Annotations::TableSectionStyleBuilder::ContinuationPropertyType ContinuationProperty ()
 Returns the continuation property
Created in NX8.0.0.
double ContinuationSpacing ()
 Returns the continuation spacing
Created in NX8.0.0.
NXOpen::Annotations::TableSectionStyleBuilder::DisplayContinuationNoteType DisplayContinuationNote ()
 Returns the display continuation note
Created in NX8.0.0.
bool DoubleBorder ()
 Returns the double border
Created in NX8.0.0.
NXOpen::Annotations::TableSectionStyleBuilder::LocationOfHeader HeaderLocation ()
 Returns the location of header
Created in NX8.0.0.
double MaximumHeight ()
 Returns the maximum height of the section
Created in NX8.0.0.
void SetAlignmentPosition (NXOpen::Annotations::TableSectionStyleBuilder::AlignmentPositionType alignmentPosition)
 Sets the alignment Position of the section
Created in NX8.0.0.
void SetBorderOffset (double borderOffset)
 Sets the border offset
Created in NX8.0.0.
void SetContinuationNote (const NXString &continuationNote)
 Sets the continuation note
Created in NX8.0.0.
void SetContinuationProperty (NXOpen::Annotations::TableSectionStyleBuilder::ContinuationPropertyType continuationProperty)
 Sets the continuation property
Created in NX8.0.0.
void SetContinuationSpacing (double spacing)
 Sets the continuation spacing
Created in NX8.0.0.
void SetDisplayContinuationNote (NXOpen::Annotations::TableSectionStyleBuilder::DisplayContinuationNoteType displayContinuationNote)
 Sets the display continuation note
Created in NX8.0.0.
void SetDoubleBorder (bool doubleBorder)
 Sets the double border
Created in NX8.0.0.
void SetHeaderLocation (NXOpen::Annotations::TableSectionStyleBuilder::LocationOfHeader headerLocation)
 Sets the location of header
Created in NX8.0.0.
void SetMaximumHeight (double maximumHeight)
 Sets the maximum height of the section
Created in NX8.0.0.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

Represents a 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

the alignment position

Enumerator:
AlignmentPositionTypeTopLeft 

Top Left.

AlignmentPositionTypeTopRight 

Top Right.

AlignmentPositionTypeBottomLeft 

Bottom Left.

AlignmentPositionTypeBottomRight 

Bottom right.

the section continuation property

Enumerator:
ContinuationPropertyTypeLeft 

Left.

ContinuationPropertyTypeRight 

Right.

ContinuationPropertyTypeUp 

Up.

ContinuationPropertyTypeDown 

Down.

ContinuationPropertyTypeNextSheet 

Next Sheet.

the display continuation note choices

Enumerator:
DisplayContinuationNoteTypeNone 

None.

DisplayContinuationNoteTypeAbove 

Above.

DisplayContinuationNoteTypeBelow 

Below.

the section header location choices

Enumerator:
LocationOfHeaderAbove 

Above.

LocationOfHeaderBelow 

Below.

LocationOfHeaderNone 

None.


Member Function Documentation

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



License requirements : None

Returns the border offset
Created in NX8.0.0.



License requirements : None

Returns the continuation note
Created in NX8.0.0.



License requirements : None

Returns the continuation property
Created in NX8.0.0.



License requirements : None

Returns the continuation spacing
Created in NX8.0.0.



License requirements : None

Returns the display continuation note
Created in NX8.0.0.



License requirements : None

Returns the double border
Created in NX8.0.0.



License requirements : None

Returns the location of header
Created in NX8.0.0.



License requirements : None

Returns the maximum height of the section
Created in NX8.0.0.



License requirements : None

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



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

Parameters:
alignmentPositionalignmentposition

Sets the border offset
Created in NX8.0.0.



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

Parameters:
borderOffsetborderoffset

Sets the continuation note
Created in NX8.0.0.



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

Parameters:
continuationNotecontinuationnote

Sets the continuation property
Created in NX8.0.0.



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

Parameters:
continuationPropertycontinuationproperty

Sets the continuation spacing
Created in NX8.0.0.



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

Parameters:
spacingspacing

Sets the display continuation note
Created in NX8.0.0.



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

Parameters:
displayContinuationNotedisplaycontinuationnote

Sets the double border
Created in NX8.0.0.



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

Parameters:
doubleBorderdoubleborder

Sets the location of header
Created in NX8.0.0.



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

Parameters:
headerLocationheaderlocation

Sets the maximum height of the section
Created in NX8.0.0.



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

Parameters:
maximumHeightmaximumheight

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.