|
NXOpen C++ Reference Guide
|
|
NXOpen C++ Reference Guide
|
Represents a TDP Template Note builder used to create Notes in the Template environment
To create a new instance of this class, use NXOpen::TDP::Manager::CreateTemplateNoteBuilder
Created in NX1847.0.0.
More...
Public Types | |
| enum | NoteTypes { NoteTypesStatic, NoteTypesUserdefined, NoteTypesControlled } |
| available template note types More... | |
 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... | |
Public Member Functions | |
| NXString | Label () |
| Returns the label used to identify the Note in Publish Created in NX1847.0.0. More... | |
| NXOpen::TDP::TemplateNoteBuilder::NoteTypes | NoteType () |
| Returns the template note type Created in NX1847.0.0. More... | |
| void | SetLabel (const NXString &labelText) |
| Sets the label used to identify the Note in Publish Created in NX1847.0.0. More... | |
| void | SetLabel (const char *labelText) |
| Sets the label used to identify the Note in Publish Created in NX1847.0.0. More... | |
| void | SetNoteType (NXOpen::TDP::TemplateNoteBuilder::NoteTypes textType) |
| Sets the template note type Created in NX1847.0.0. More... | |
| Public Member Functions inherited from NXOpen::Annotations::DraftingNoteBuilder | |
| 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... | |
Represents a TDP Template Note builder used to create Notes in the Template environment
To create a new instance of this class, use NXOpen::TDP::Manager::CreateTemplateNoteBuilder
Created in NX1847.0.0.
| NXString NXOpen::TDP::TemplateNoteBuilder::Label | ( | ) |
Returns the label used to identify the Note in Publish
Created in NX1847.0.0.
License requirements : None
| NXOpen::TDP::TemplateNoteBuilder::NoteTypes NXOpen::TDP::TemplateNoteBuilder::NoteType | ( | ) |
Returns the template note type
Created in NX1847.0.0.
License requirements : None
| void NXOpen::TDP::TemplateNoteBuilder::SetLabel | ( | const NXString & | labelText | ) |
Sets the label used to identify the Note in Publish
Created in NX1847.0.0.
License requirements : None
| labelText | labeltext |
| void NXOpen::TDP::TemplateNoteBuilder::SetLabel | ( | const char * | labelText | ) |
Sets the label used to identify the Note in Publish
Created in NX1847.0.0.
License requirements : None
| labelText | labeltext |
| void NXOpen::TDP::TemplateNoteBuilder::SetNoteType | ( | NXOpen::TDP::TemplateNoteBuilder::NoteTypes | textType | ) |
Sets the template note type
Created in NX1847.0.0.
License requirements : None
| textType | texttype |
