DraftingNoteBuilder Class¶
-
class
NXOpen.Annotations.
DraftingNoteBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Annotations.Note
builderTo 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 New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
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. |
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 |
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. |
Enumerations¶
DraftingNoteBuilderTextAlign Enumeration | text over leader types for text |
DraftingNoteBuilderThicknessTypes Enumeration | thickness types for text |
Property Detail¶
ForeshorteningSymbol¶
-
DraftingNoteBuilder.
ForeshorteningSymbol
¶ Returns the foreshortening symbol builder
-------------------------------------
Getter Method
Signature
ForeshorteningSymbol
Returns: Return type: NXOpen.Annotations.ForeshorteningSymbolBuilder
New in version NX10.0.0.
License requirements: None.
Inherit¶
-
DraftingNoteBuilder.
Inherit
¶ Returns the note from which the properties are inherited
-------------------------------------
Getter Method
Signature
Inherit
Returns: Return type: NXOpen.SelectDisplayableObject
New in version NX7.5.2.
License requirements: None.
Leader¶
-
DraftingNoteBuilder.
Leader
¶ Returns the
NXOpen.Annotations.LeaderBuilder
for the annotation-------------------------------------
Getter Method
Signature
Leader
Returns: Return type: NXOpen.Annotations.LeaderBuilder
New in version NX6.0.0.
License requirements: None.
Origin¶
-
DraftingNoteBuilder.
Origin
¶ Returns the origin
-------------------------------------
Getter Method
Signature
Origin
Returns: Return type: NXOpen.Annotations.OriginBuilder
New in version NX6.0.0.
License requirements: None.
Style¶
-
DraftingNoteBuilder.
Style
¶ Returns the style builder
-------------------------------------
Getter Method
Signature
Style
Returns: Return type: NXOpen.Annotations.StyleBuilder
New in version NX6.0.0.
License requirements: None.
Text¶
-
DraftingNoteBuilder.
Text
¶ Returns the text
-------------------------------------
Getter Method
Signature
Text
Returns: Return type: NXOpen.Annotations.TextWithEditControlsBuilder
New in version NX6.0.0.
License requirements: None.
TextAlignment¶
-
DraftingNoteBuilder.
TextAlignment
¶ Returns or sets the text alignment
-------------------------------------
Getter Method
Signature
TextAlignment
Returns: Return type: NXOpen.Annotations.DraftingNoteBuilderTextAlign
New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
-------------------------------------
Setter Method
Signature
TextAlignment
Parameters: textAlignment ( NXOpen.Annotations.DraftingNoteBuilderTextAlign
) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
VerticalText¶
-
DraftingNoteBuilder.
VerticalText
¶ Returns or sets the vertical text for text
-------------------------------------
Getter Method
Signature
VerticalText
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
VerticalText
Parameters: verticalText (bool) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
Method Detail¶
InheritProperties¶
-
DraftingNoteBuilder.
InheritProperties
¶ Inheriting properties from the note
Signature
InheritProperties(annotation, recordNumber)
Parameters: - annotation (
NXOpen.Annotations.SimpleDraftingAid
) – - recordNumber (int) –
New in version NX7.5.2.
License requirements: None.
- annotation (
Validate¶
-
DraftingNoteBuilder.
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.