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

Represents a base Builder for Drafting and PMI Custom Symbol
This is an abstract class, and cannot be instantiated. More...

Inheritance diagram for NXOpen::Annotations::BaseCustomSymbolBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Annotations::DraftingCustomSymbolBuilder NXOpen::Annotations::PmiCustomSymbolBuilder

List of all members.

Public Types

enum  AnnotationPreferences { AnnotationPreferencesUseCurrent, AnnotationPreferencesUseDefinition }
 Enum for Annotation Preferences This is used by Annotations::BaseCustomSymbolBuilder::AnnotationPreference and Annotations::BaseCustomSymbolBuilder::SetAnnotationPreference to set the annotation preferences for a symbol. More...
enum  GeometryPreferences { GeometryPreferencesUseCurrent, GeometryPreferencesUseDefinition }
 Enum for Geometric Preferences This is used by Annotations::BaseCustomSymbolBuilder::GeometryPreference and Annotations::BaseCustomSymbolBuilder::SetGeometryPreference to set the geometric preferences for a symbol. More...

Public Member Functions

NXOpen::ExpressionAngle ()
 Returns the angle
Created in NX7.5.0.
NXOpen::Annotations::BaseCustomSymbolBuilder::AnnotationPreferences AnnotationPreference ()
 Returns the enum annot pref.
int ControlledNoteTitle ()
 Returns the controlled note title
Created in NX7.5.0.
NXOpen::Annotations::BaseCustomSymbolBuilder::GeometryPreferences GeometryPreference ()
 Returns the enum geom pref.
std::vector< NXStringGetArbitraryNoteTitle ()
 Returns the arbitrary note title.
NXOpen::Annotations::BaseCustomSymbolGetSymbol ()
 Returns the custom symbol.
bool HorizontalFlip ()
 Returns the horizontal flip
Created in NX7.5.0.
int Integer ()
 Returns the integer
Created in NX7.5.0.
bool IsPartSymbol ()
 Returns the is part symbol.
NXOpen::Annotations::LeaderBuilderLeader ()
 Returns the Annotations::LeaderBuilder for the annotation
Created in NX7.5.0.
bool LockStatus ()
 Returns the get symbol lock property
Created in NX8.0.0.
NXString MasterSymbolName ()
 Returns the master symbol Name.
NXString MasterSymbolPath ()
 Returns the master symbol path.
NXOpen::Annotations::OriginBuilderOrigin ()
 Returns the origin
Created in NX7.5.0.
NXString PartiallyControlledNoteTitle ()
 Returns the partially controlled note title
Created in NX7.5.0.
double Real ()
 Returns the real value
Created in NX7.5.0.
NXOpen::ExpressionScale ()
 Returns the scale
Created in NX7.5.0.
void SelectPartSymbol (const NXString &name, const NXString &path)
 Selects part custom symbol
Created in NX7.5.0.
void SelectSymbol (const NXString &name)
 Selects custom symbol
Created in NX7.5.0.
void SelectText (int index)
 Setting the selected note at builder side
Created in NX7.5.0.
void SetAnnotationPreference (NXOpen::Annotations::BaseCustomSymbolBuilder::AnnotationPreferences enumAnnotPref)
 Sets the enum annot pref.
void SetArbitraryNoteTitle (const std::vector< NXString > &arbitraryNoteTitle)
 Sets the arbitrary note title
Created in NX7.5.0.
void SetControlledNoteTitle (int controlledNoteTitle)
 Sets the controlled note title
Created in NX7.5.0.
void SetGeometryPreference (NXOpen::Annotations::BaseCustomSymbolBuilder::GeometryPreferences enumGeomPref)
 Sets the enum geom pref.
void SetHorizontalFlip (bool horizontalFlip)
 Sets the horizontal flip
Created in NX7.5.0.
void SetInteger (int integer)
 Sets the integer
Created in NX7.5.0.
void SetLockStatus (bool lockUpdate)
 Sets the get symbol lock property
Created in NX8.0.0.
void SetMasterSymbolName (const NXString &masterSymbolName)
 Sets the master symbol Name.
void SetMasterSymbolPath (const NXString &masterSymbolPath)
 Sets the master symbol path.
void SetPartiallyControlledNoteTitle (const NXString &partiallyControlledNoteTitle)
 Sets the partially controlled note title
Created in NX7.5.0.
void SetPartSymbol (bool isPartSymbol)
 Sets the is part symbol.
void SetReal (double real)
 Sets the real value
Created in NX7.5.0.
void SetSmashSymbol (bool smashSymbol)
 Sets the smash symbol
Created in NX7.5.0.
void SetVerticalFlip (bool verticalFlip)
 Sets the vertical flip
Created in NX7.5.0.
bool SmashSymbol ()
 Returns the smash symbol
Created in NX7.5.0.
NXOpen::Annotations::StyleBuilderStyle ()
 Returns the style builder
Created in NX7.5.0.
NXOpen::Annotations::MasterSymbolListItemBuilderListTexts ()
 Returns the texts
Created in NX7.5.0.
bool VerticalFlip ()
 Returns the vertical flip
Created in NX7.5.0.

Detailed Description

Represents a base Builder for Drafting and PMI Custom Symbol
This is an abstract class, and cannot be instantiated.



Created in NX7.5.0.


Member Enumeration Documentation

Enum for Annotation Preferences This is used by Annotations::BaseCustomSymbolBuilder::AnnotationPreference and Annotations::BaseCustomSymbolBuilder::SetAnnotationPreference to set the annotation preferences for a symbol.

Enumerator:
AnnotationPreferencesUseCurrent 

Current preferences.

AnnotationPreferencesUseDefinition 

Defined preferences.

Enum for Geometric Preferences This is used by Annotations::BaseCustomSymbolBuilder::GeometryPreference and Annotations::BaseCustomSymbolBuilder::SetGeometryPreference to set the geometric preferences for a symbol.

Enumerator:
GeometryPreferencesUseCurrent 

Current preferences.

GeometryPreferencesUseDefinition 

Defined preferences.


Member Function Documentation

Returns the angle
Created in NX7.5.0.



License requirements : None

Returns the enum annot pref.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : None

Returns the controlled note title
Created in NX7.5.0.



License requirements : None

Returns the enum geom pref.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : None

Returns the arbitrary note title.

Returns:

Created in NX7.5.0.

License requirements : None

Returns the custom symbol.

Returns:
The custom symbol
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Returns the horizontal flip
Created in NX7.5.0.



License requirements : None

Returns the integer
Created in NX7.5.0.



License requirements : None

Returns the is part symbol.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : None

Returns the Annotations::LeaderBuilder for the annotation
Created in NX7.5.0.



License requirements : None

Returns the get symbol lock property
Created in NX8.0.0.



License requirements : None

Returns the master symbol Name.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : None

Returns the master symbol path.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : None

Returns the origin
Created in NX7.5.0.



License requirements : None

Returns the partially controlled note title
Created in NX7.5.0.



License requirements : None

Returns the real value
Created in NX7.5.0.



License requirements : None

Returns the scale
Created in NX7.5.0.



License requirements : None

Selects part custom symbol
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
nameName of symbol
pathPartSymbol full Path

Selects custom symbol
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
nameName of symbol

Setting the selected note at builder side
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
indexindex of selected text

Sets the enum annot pref.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters:
enumAnnotPrefenumannotpref
void NXOpen::Annotations::BaseCustomSymbolBuilder::SetArbitraryNoteTitle ( const std::vector< NXString > &  arbitraryNoteTitle)

Sets the arbitrary note title
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
arbitraryNoteTitlearbitrarynotetitle

Sets the controlled note title
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
controlledNoteTitlecontrollednotetitle

Sets the enum geom pref.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters:
enumGeomPrefenumgeompref

Sets the horizontal flip
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
horizontalFliphorizontalflip

Sets the integer
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
integerinteger

Sets the get symbol lock property
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
lockUpdatelockupdate

Sets the master symbol Name.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters:
masterSymbolNamemastersymbolname

Sets the master symbol path.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters:
masterSymbolPathmastersymbolpath

Sets the partially controlled note title
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
partiallyControlledNoteTitlepartiallycontrollednotetitle

Sets the is part symbol.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters:
isPartSymbolispartsymbol

Sets the real value
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
realreal

Sets the smash symbol
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
smashSymbolsmashsymbol

Sets the vertical flip
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
verticalFlipverticalflip

Returns the smash symbol
Created in NX7.5.0.



License requirements : None

Returns the style builder
Created in NX7.5.0.



License requirements : None

Returns the texts
Created in NX7.5.0.



License requirements : None

Returns the vertical flip
Created in NX7.5.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.