CaeNoteBuilder Class¶
-
class
NXOpen.CAE.
CaeNoteBuilder
¶ Bases:
NXOpen.Annotations.DraftingNoteBuilder
Represents a CAE note builder class
To create a new instance of this class, use
NXOpen.CAE.NoteManager.CreateCaeNoteBuilder()
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
AssociatedObjects | Returns the associated objects for the annotation |
ForeshorteningSymbol | Returns the foreshortening symbol builder |
Inherit | Returns the note from which the properties are inherited |
Leader | Returns the NXOpen.Annotations.LeaderBuilder for the annotation |
Origin | Returns the origin |
Style | Returns the style builder |
Tag | Returns the Tag for this object. |
Text | Returns the text |
TextAlignment | Returns or sets the text alignment |
VerticalText | Returns or sets the vertical text for text |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
ConvertLabelToNote | Covert CAE Label to Note |
ConvertNoteToLabel | Covert CAE Note to Label |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
InheritProperties | Inheriting properties from the note |
SetFolderName | Sets folder name into the builder |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AssociatedObjects¶
-
CaeNoteBuilder.
AssociatedObjects
¶ Returns the associated objects for the annotation
-------------------------------------
Getter Method
Signature
AssociatedObjects
Returns: Return type: NXOpen.SelectTaggedObjectList
New in version NX12.0.0.
License requirements: None.
Method Detail¶
ConvertLabelToNote¶
-
CaeNoteBuilder.
ConvertLabelToNote
¶ Covert CAE Label to Note
Signature
ConvertLabelToNote(annotation)
Parameters: annotation ( NXOpen.Annotations.NoteBase
) –New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
ConvertNoteToLabel¶
-
CaeNoteBuilder.
ConvertNoteToLabel
¶ Covert CAE Note to Label
Signature
ConvertNoteToLabel(annotation)
Parameters: annotation ( NXOpen.Annotations.NoteBase
) –New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
SetFolderName¶
-
CaeNoteBuilder.
SetFolderName
¶ Sets folder name into the builder
Signature
SetFolderName(folderName)
Parameters: folderName (str) – New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
Validate¶
-
CaeNoteBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.