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

Represents a Note builder
To create a new instance of this class, use Annotations::AnnotationManager::CreateDraftingNoteBuilder
Default values. More...

Inheritance diagram for NXOpen::Annotations::DraftingNoteBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Annotations::PmiNoteBuilder

List of all members.

Public Types

enum  TextAlign {
  TextAlignTop, TextAlignMiddle, TextAlignBottom, TextAlignBelowbottomExtToMax,
  TextAlignBelowbottomExtToMaxUnderline, TextAlignBelowbottom, TextAlignBelowbottomUnderline, TextAlignBelowTopExtToMax,
  TextAlignBelowTopExtToMaxUnderline, TextAlignBelowTop, TextAlignBelowTopUnderline
}
 text over leader types for text More...
enum  ThicknessTypes { ThicknessTypesMedium, ThicknessTypesThick }
 thickness types for text More...

Public Member Functions

NXOpen::SelectDisplayableObjectInherit ()
 Returns the note from which the properties are inherited
Created in NX7.5.2.
void InheritProperties (NXOpen::Annotations::SimpleDraftingAid *annotation, int recordNumber)
 Inheriting properties from the note
Created in NX7.5.2.
NXOpen::Annotations::LeaderBuilderLeader ()
 Returns the Annotations::LeaderBuilder for the annotation
Created in NX6.0.0.
NXOpen::Annotations::OriginBuilderOrigin ()
 Returns the origin
Created in NX6.0.0.
void SetTextAlignment (NXOpen::Annotations::DraftingNoteBuilder::TextAlign textAlignment)
 Sets the text alignment
Created in NX6.0.0.
void SetVerticalText (bool verticalText)
 Sets the vertical text for text
Created in NX6.0.0.
NXOpen::Annotations::StyleBuilderStyle ()
 Returns the style builder
Created in NX6.0.0.
NXOpen::Annotations::TextWithEditControlsBuilderText ()
 Returns the text
Created in NX6.0.0.
NXOpen::Annotations::DraftingNoteBuilder::TextAlign TextAlignment ()
 Returns the text alignment
Created in NX6.0.0.
bool VerticalText ()
 Returns the vertical text for text
Created in NX6.0.0.

Detailed Description

Represents a Note builder
To create a new instance of this class, use Annotations::AnnotationManager::CreateDraftingNoteBuilder
Default values.

Property Value

Text.TextBlock.CustomSymbolScale

1.0

Text.TextBlock.SymbolAspectRatio

1.0

Text.TextBlock.SymbolHeight

25.4 (millimeters part), 1.0 (inches part)

Text.TextBlock.SymbolLength

25.4 (millimeters part), 1.0 (inches part)

Text.TextBlock.SymbolPreferences

UseCurrent

Text.TextBlock.SymbolScale

1.0

Text.TextBlock.SymbolSizeMethod

ScaleAndAspectRatio


Created in NX6.0.0.


Member Enumeration Documentation

text over leader types for text

Enumerator:
TextAlignTop 

Align top.

TextAlignMiddle 

Align middle.

TextAlignBottom 

Align bottom.

TextAlignBelowbottomExtToMax 

Align below bottom extension to maximum.

TextAlignBelowbottomExtToMaxUnderline 

Align below bottom extension to maximum and underline.

TextAlignBelowbottom 

Align below bottom.

TextAlignBelowbottomUnderline 

Align below bottom and underline.

TextAlignBelowTopExtToMax 

Align below top extension to maximum.

TextAlignBelowTopExtToMaxUnderline 

Align below top extension to maximum and underline.

TextAlignBelowTop 

Align below top.

TextAlignBelowTopUnderline 

Align below top and underline.

thickness types for text

Enumerator:
ThicknessTypesMedium 

Medium thickness type.

ThicknessTypesThick 

Thick thickness type.


Member Function Documentation

Returns the note from which the properties are inherited
Created in NX7.5.2.



License requirements : None

Inheriting properties from the note
Created in NX7.5.2.



License requirements : None

Parameters:
annotationannotation
recordNumberrecordnumber

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



License requirements : None

Returns the origin
Created in NX6.0.0.



License requirements : None

Sets the text alignment
Created in NX6.0.0.



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

Parameters:
textAlignmenttextalignment

Sets the vertical text for text
Created in NX6.0.0.



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

Parameters:
verticalTextverticaltext

Returns the style builder
Created in NX6.0.0.



License requirements : None

Returns the text
Created in NX6.0.0.



License requirements : None

Returns the text alignment
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Returns the vertical text for text
Created in NX6.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.