NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::AME::GeneralAnnotationSettingsBuilder Class Reference

builder for the general annotation settings dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateGeneralAnnotationSettingsBuilder

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::AME::GeneralAnnotationSettingsBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  AnnotationSeparator { AnnotationSeparatorSemiColon, AnnotationSeparatorComma, AnnotationSeparatorMultiline }
 the separator for annotation set More...
 
enum  HorizontalTextPosition { HorizontalTextPositionAbove, HorizontalTextPositionBelow }
 horizontal text postion type More...
 
enum  SourceAndTargetSeparator { SourceAndTargetSeparatorLessthanGreaterthan, SourceAndTargetSeparatorSemiColon }
 the separator between Source and Target More...
 
enum  VerticalTextPosition { VerticalTextPositionLeft, VerticalTextPositionRight }
 verical text postion type More...
 

Public Member Functions

NXOpen::AME::GeneralAnnotationSettingsBuilder::AnnotationSeparator AnnotationSetSeparator ()
 Returns the separator for annotation set
Created in NX11.0.0. More...
 
double Offset ()
 Returns the text offset
Created in NX11.0.0. More...
 
void ResetToDefault ()
 Set the default values
Created in NX11.0.0. More...
 
void SetAnnotationSetSeparator (NXOpen::AME::GeneralAnnotationSettingsBuilder::AnnotationSeparator type)
 Sets the separator for annotation set
Created in NX11.0.0. More...
 
void SetOffset (double textOffset)
 Sets the text offset
Created in NX11.0.0. More...
 
void SetSourceTargetSeparator (NXOpen::AME::GeneralAnnotationSettingsBuilder::SourceAndTargetSeparator type)
 Sets the separator between source and target
Created in NX11.0.0. More...
 
void SetTextHeight (double textHeight)
 Sets the text height
Created in NX11.0.0. More...
 
void SetTextPositionHorizontal (NXOpen::AME::GeneralAnnotationSettingsBuilder::HorizontalTextPosition type)
 Sets the horizontal text position
Created in NX11.0.0. More...
 
void SetTextPositionVertical (NXOpen::AME::GeneralAnnotationSettingsBuilder::VerticalTextPosition type)
 Sets the vertical text position
Created in NX11.0.0. More...
 
NXOpen::AME::GeneralAnnotationSettingsBuilder::SourceAndTargetSeparator SourceTargetSeparator ()
 Returns the separator between source and target
Created in NX11.0.0. More...
 
NXOpen::TextColorFontWidthBuilderTextCFW ()
 Returns the text color font width
Created in NX11.0.0. More...
 
double TextHeight ()
 Returns the text height
Created in NX11.0.0. More...
 
NXOpen::AME::GeneralAnnotationSettingsBuilder::HorizontalTextPosition TextPositionHorizontal ()
 Returns the horizontal text position
Created in NX11.0.0. More...
 
NXOpen::AME::GeneralAnnotationSettingsBuilder::VerticalTextPosition TextPositionVertical ()
 Returns the vertical text position
Created in NX11.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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

builder for the general annotation settings dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateGeneralAnnotationSettingsBuilder

Created in NX11.0.0.


Member Enumeration Documentation

the separator for annotation set

Enumerator
AnnotationSeparatorSemiColon 

semi colon

AnnotationSeparatorComma 

comma

AnnotationSeparatorMultiline 

multiline

horizontal text postion type

Enumerator
HorizontalTextPositionAbove 

above

HorizontalTextPositionBelow 

below

the separator between Source and Target

Enumerator
SourceAndTargetSeparatorLessthanGreaterthan 

lessthan greaterthan

SourceAndTargetSeparatorSemiColon 

semi colon

verical text postion type

Enumerator
VerticalTextPositionLeft 

left

VerticalTextPositionRight 

right

Member Function Documentation

NXOpen::AME::GeneralAnnotationSettingsBuilder::AnnotationSeparator NXOpen::AME::GeneralAnnotationSettingsBuilder::AnnotationSetSeparator ( )

Returns the separator for annotation set
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

double NXOpen::AME::GeneralAnnotationSettingsBuilder::Offset ( )

Returns the text offset
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::GeneralAnnotationSettingsBuilder::ResetToDefault ( )

Set the default values
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::GeneralAnnotationSettingsBuilder::SetAnnotationSetSeparator ( NXOpen::AME::GeneralAnnotationSettingsBuilder::AnnotationSeparator  type)

Sets the separator for annotation set
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
typetype
void NXOpen::AME::GeneralAnnotationSettingsBuilder::SetOffset ( double  textOffset)

Sets the text offset
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
textOffsettextoffset
void NXOpen::AME::GeneralAnnotationSettingsBuilder::SetSourceTargetSeparator ( NXOpen::AME::GeneralAnnotationSettingsBuilder::SourceAndTargetSeparator  type)

Sets the separator between source and target
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
typetype
void NXOpen::AME::GeneralAnnotationSettingsBuilder::SetTextHeight ( double  textHeight)

Sets the text height
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
textHeighttextheight
void NXOpen::AME::GeneralAnnotationSettingsBuilder::SetTextPositionHorizontal ( NXOpen::AME::GeneralAnnotationSettingsBuilder::HorizontalTextPosition  type)

Sets the horizontal text position
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
typetype
void NXOpen::AME::GeneralAnnotationSettingsBuilder::SetTextPositionVertical ( NXOpen::AME::GeneralAnnotationSettingsBuilder::VerticalTextPosition  type)

Sets the vertical text position
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
typetype
NXOpen::AME::GeneralAnnotationSettingsBuilder::SourceAndTargetSeparator NXOpen::AME::GeneralAnnotationSettingsBuilder::SourceTargetSeparator ( )

Returns the separator between source and target
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::TextColorFontWidthBuilder* NXOpen::AME::GeneralAnnotationSettingsBuilder::TextCFW ( )

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



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

double NXOpen::AME::GeneralAnnotationSettingsBuilder::TextHeight ( )

Returns the text height
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::GeneralAnnotationSettingsBuilder::HorizontalTextPosition NXOpen::AME::GeneralAnnotationSettingsBuilder::TextPositionHorizontal ( )

Returns the horizontal text position
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::GeneralAnnotationSettingsBuilder::VerticalTextPosition NXOpen::AME::GeneralAnnotationSettingsBuilder::TextPositionVertical ( )

Returns the vertical text position
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")


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