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

Inheritance diagram for NXOpen::Annotations::DraftingNoteBuilder:

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::Annotations::ForeshorteningSymbolBuilder *	ForeshorteningSymbol ()
	Returns the foreshortening symbol builder Created in NX10.0.0. More...

NXOpen::SelectDisplayableObject *	Inherit ()
	Returns the note from which the properties are inherited Created in NX7.5.2. More...

void	InheritProperties (NXOpen::Annotations::SimpleDraftingAid *annotation, int recordNumber)
	Inheriting properties from the note Created in NX7.5.2. More...

NXOpen::Annotations::LeaderBuilder *	Leader ()
	Returns the NXOpen::Annotations::LeaderBuilder for the annotation Created in NX6.0.0. More...

NXOpen::Annotations::OriginBuilder *	Origin ()
	Returns the origin Created in NX6.0.0. More...

void	SetTextAlignment (NXOpen::Annotations::DraftingNoteBuilder::TextAlign textAlignment)
	Sets the text alignment Created in NX6.0.0. More...

void	SetVerticalText (bool verticalText)
	Sets the vertical text for text Created in NX6.0.0. More...

NXOpen::Annotations::StyleBuilder *	Style ()
	Returns the style builder Created in NX6.0.0. More...

NXOpen::Annotations::TextWithEditControlsBuilder *	Text ()
	Returns the text Created in NX6.0.0. More...

NXOpen::Annotations::DraftingNoteBuilder::TextAlign	TextAlignment ()
	Returns the text alignment Created in NX6.0.0. More...

bool	VerticalText ()
	Returns the vertical text for text Created in NX6.0.0. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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

Represents a NXOpen::Annotations::Note builder
To create a new instance of this class, use NXOpen::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

enum NXOpen::Annotations::DraftingNoteBuilder::TextAlign

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.

enum NXOpen::Annotations::DraftingNoteBuilder::ThicknessTypes

thickness types for text

Enumerator
ThicknessTypesMedium	Medium thickness type.
ThicknessTypesThick	Thick thickness type.

Member Function Documentation

NXOpen::Annotations::ForeshorteningSymbolBuilder* NXOpen::Annotations::DraftingNoteBuilder::ForeshorteningSymbol ( )

Returns the foreshortening symbol builder
Created in NX10.0.0.

License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Annotations::DraftingNoteBuilder::Inherit ( )

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

License requirements : None

void NXOpen::Annotations::DraftingNoteBuilder::InheritProperties	(	NXOpen::Annotations::SimpleDraftingAid *	annotation,
		int	recordNumber
	)

Inheriting properties from the note
Created in NX7.5.2.

License requirements : None

Parameters

annotation	annotation
recordNumber	recordnumber

NXOpen::Annotations::LeaderBuilder* NXOpen::Annotations::DraftingNoteBuilder::Leader ( )

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

License requirements : None

NXOpen::Annotations::OriginBuilder* NXOpen::Annotations::DraftingNoteBuilder::Origin ( )

Returns the origin
Created in NX6.0.0.

License requirements : None

void NXOpen::Annotations::DraftingNoteBuilder::SetTextAlignment ( NXOpen::Annotations::DraftingNoteBuilder::TextAlign textAlignment )

Sets the text alignment
Created in NX6.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters

textAlignment textalignment

void NXOpen::Annotations::DraftingNoteBuilder::SetVerticalText ( bool verticalText )

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

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters

verticalText verticaltext

NXOpen::Annotations::StyleBuilder* NXOpen::Annotations::DraftingNoteBuilder::Style ( )

Returns the style builder
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::TextWithEditControlsBuilder* NXOpen::Annotations::DraftingNoteBuilder::Text ( )

Returns the text
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::DraftingNoteBuilder::TextAlign NXOpen::Annotations::DraftingNoteBuilder::TextAlignment ( )

Returns the text alignment
Created in NX6.0.0.

License requirements : drafting ("DRAFTING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

bool NXOpen::Annotations::DraftingNoteBuilder::VerticalText ( )

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:

Annotations_DraftingNoteBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation