NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAE::CaeNoteBuilder Class Reference

Represents a CAE note builder class
To create a new instance of this class, use NXOpen::CAE::NoteManager::CreateCaeNoteBuilder

Created in NX12.0.0. More...

Inheritance diagram for NXOpen::CAE::CaeNoteBuilder:
NXOpen::Annotations::DraftingNoteBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::SelectTaggedObjectListAssociatedObjects ()
 Returns the associated objects for the annotation
Created in NX12.0.0. More...
 
void ConvertLabelToNote (NXOpen::Annotations::NoteBase *annotation)
 Covert CAE Label to Note
Created in NX12.0.0. More...
 
void ConvertNoteToLabel (NXOpen::Annotations::NoteBase *annotation)
 Covert CAE Note to Label
Created in NX12.0.0. More...
 
void SetFolderName (const NXString &folderName)
 Sets folder name into the builder
Created in NX12.0.0. More...
 
void SetFolderName (const char *folderName)
 Sets folder name into the builder
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::Annotations::DraftingNoteBuilder
NXOpen::Annotations::ForeshorteningSymbolBuilderForeshorteningSymbol ()
 Returns the foreshortening symbol builder
Created in NX10.0.0. More...
 
NXOpen::SelectDisplayableObjectInherit ()
 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::LeaderBuilderLeader ()
 Returns the NXOpen::Annotations::LeaderBuilder for the annotation
Created in NX6.0.0. More...
 
NXOpen::Annotations::OriginBuilderOrigin ()
 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::StyleBuilderStyle ()
 Returns the style builder
Created in NX6.0.0. More...
 
NXOpen::Annotations::TextWithEditControlsBuilderText ()
 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::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...
 

Additional Inherited Members

- Public Types inherited from NXOpen::Annotations::DraftingNoteBuilder
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...
 

Detailed Description

Represents a CAE note builder class
To create a new instance of this class, use NXOpen::CAE::NoteManager::CreateCaeNoteBuilder

Created in NX12.0.0.


Member Function Documentation

NXOpen::SelectTaggedObjectList* NXOpen::CAE::CaeNoteBuilder::AssociatedObjects ( )

Returns the associated objects for the annotation
Created in NX12.0.0.



License requirements : None

void NXOpen::CAE::CaeNoteBuilder::ConvertLabelToNote ( NXOpen::Annotations::NoteBase annotation)

Covert CAE Label to Note
Created in NX12.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
annotationannotation
void NXOpen::CAE::CaeNoteBuilder::ConvertNoteToLabel ( NXOpen::Annotations::NoteBase annotation)

Covert CAE Note to Label
Created in NX12.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
annotationannotation
void NXOpen::CAE::CaeNoteBuilder::SetFolderName ( const NXString folderName)

Sets folder name into the builder
Created in NX12.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
folderNamefoldername
void NXOpen::CAE::CaeNoteBuilder::SetFolderName ( const char *  folderName)

Sets folder name into the builder
Created in NX12.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
folderNamefoldername

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