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

Represents a Annotations::IdSymbol builder
To create a new instance of this class, use Annotations::IdSymbolCollection::CreateIdSymbolBuilder
Default values. More...

Inheritance diagram for NXOpen::Annotations::IdSymbolBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  SymbolTypes {
  SymbolTypesCircle, SymbolTypesDividedCircle, SymbolTypesTriangle, SymbolTypesTriangleUp,
  SymbolTypesSquare, SymbolTypesDividedSquare, SymbolTypesHexagon, SymbolTypesDividedHexagon,
  SymbolTypesQuadrantCircle, SymbolTypesRoundedBox, SymbolTypesUnderline
}
 the valid types for an id symbol More...

Public Member Functions

NXOpen::SelectObjectInherit ()
 Returns the inherit The id symbol from which the style properties are inherited
Created in NX5.0.0.
NXOpen::Annotations::LeaderBuilderLeader ()
 Returns the Annotations::LeaderBuilder for the annotation
Created in NX6.0.0.
NXString LowerText ()
 Returns the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.
NXOpen::Annotations::OriginBuilderOrigin ()
 Returns the origin, where the symbol is going to be displayed
Created in NX6.0.0.
NXOpen::Annotations::AnnotationPlacementPlacement ()
 Returns an annotation placement object

void SetLowerText (const NXString &lowerText)
 Sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.
void SetPreviewObject (NXOpen::Annotations::IdSymbol *symbol)
 Sets the preview object for dialog creation of id symbols

void SetSize (double size)
 Sets the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle
Created in NX5.0.0.
void SetSymbolType (NXOpen::Annotations::IdSymbolBuilder::SymbolTypes symbolType)
 Sets the symbol type

void SetType (NXOpen::Annotations::IdSymbolBuilder::SymbolTypes type)
 Sets the symbol type
Created in NX6.0.0.
void SetUpperText (const NXString &upperText)
 Sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.
double Size ()
 Returns the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle
Created in NX5.0.0.
NXOpen::Annotations::StyleBuilderStyle ()
 Returns the style
Created in NX6.0.0.
NXOpen::Annotations::IdSymbolBuilder::SymbolTypes SymbolType ()
 Returns the symbol type

NXOpen::Annotations::IdSymbolBuilder::SymbolTypes Type ()
 Returns the symbol type
Created in NX6.0.0.
NXString UpperText ()
 Returns the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.

Detailed Description

Represents a Annotations::IdSymbol builder
To create a new instance of this class, use Annotations::IdSymbolCollection::CreateIdSymbolBuilder
Default values.

Property Value

Size

0


Created in NX5.0.0.


Member Enumeration Documentation

the valid types for an id symbol

Enumerator:
SymbolTypesCircle 

Circle.

SymbolTypesDividedCircle 

Divided circle.

SymbolTypesTriangle 

Triangle with point down.

SymbolTypesTriangleUp 

Triangle with point up.

SymbolTypesSquare 

Square.

SymbolTypesDividedSquare 

Divided square.

SymbolTypesHexagon 

Hexagon.

SymbolTypesDividedHexagon 

Divided hexagon.

SymbolTypesQuadrantCircle 

Quadrant circle.

SymbolTypesRoundedBox 

Rounded box.

SymbolTypesUnderline 

Underline.


Member Function Documentation

Returns the inherit The id symbol from which the style properties are inherited
Created in NX5.0.0.



License requirements : None

Returns the Annotations::LeaderBuilder for the annotation
Created in NX6.0.0.



License requirements : None

Returns the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.


Created in NX5.0.0.

License requirements : None

Returns the origin, where the symbol is going to be displayed
Created in NX6.0.0.



License requirements : None

Returns an annotation placement object

Deprecated:
Deprecated in NX6.0.0.



Created in NX5.0.0.

License requirements : None

Sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.


Created in NX5.0.0.

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

Parameters:
lowerTextlowertext

Sets the preview object for dialog creation of id symbols

Deprecated:
Deprecated in NX6.0.0.



Created in NX5.0.0.

License requirements : None

Parameters:
symbolrubberbanding symbol

Sets the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle
Created in NX5.0.0.



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

Parameters:
sizesize

Sets the symbol type

Deprecated:
Deprecated in NX6.0.0.



Created in NX5.0.0.

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

Parameters:
symbolTypesymboltype

Sets the symbol type
Created in NX6.0.0.



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

Parameters:
typetype

Sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.


Created in NX5.0.0.

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

Parameters:
upperTextuppertext

Returns the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle
Created in NX5.0.0.



License requirements : None

Returns the style
Created in NX6.0.0.



License requirements : None

Returns the symbol type

Deprecated:
Deprecated in NX6.0.0.



Created in NX5.0.0.

License requirements : None

Returns the symbol type
Created in NX6.0.0.



License requirements : None

Returns the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.


Created in NX5.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.