CoordinateNoteBuilder Class¶
-
class
NXOpen.Annotations.
CoordinateNoteBuilder
¶ Bases:
NXOpen.Annotations.PmiAttributeBuilder
Represents a
NXOpen.Annotations.CoordinateNote
builderTo create a new instance of this class, use
NXOpen.Annotations.PmiAttributeCollection.CreateCoordinateNoteBuilder()
Default values.
Property Value ToggleI 0 ToggleJ 0 ToggleK 0 ToggleLabel 0 ToggleLevel 0 ToggleX 0 ToggleY 0 ToggleZ 0 New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AssociatedObjects | Returns the NXOpen.Annotations.AssociatedObjectsBuilder for the annotation |
Attribute | Returns or sets the NXOpen.Annotations.Pmi for this annotation |
BusinessModifier | Returns or sets the business modifier |
Category | Returns or sets the category |
DecimalPlace | Returns or sets the decimal place for coordinate note display |
Identifier | Returns or sets the identifier |
KnowledgeFusionClassName | Returns or sets the knowledge fusion class name file, the default class is UG provided pmi KF class |
Leader | Returns the NXOpen.Annotations.LeaderBuilder for the annotation |
Origin | Returns the NXOpen.Annotations.OriginBuilder for the annotation |
Revision | Returns or sets the revision |
StringPrefixI | Returns or sets the string prefix i |
StringPrefixJ | Returns or sets the string prefix j |
StringPrefixK | Returns or sets the string prefix k |
StringPrefixLabel | Returns or sets the string prefix label |
StringPrefixLevel | Returns or sets the string prefix level |
StringPrefixX | Returns or sets the string prefix x |
StringPrefixY | Returns or sets the string prefix y |
StringPrefixZ | Returns or sets the string prefix z |
StringSuffixI | Returns or sets the string suffix i |
StringSuffixJ | Returns or sets the string suffix j |
StringSuffixK | Returns or sets the string suffix k |
StringSuffixLabel | Returns or sets the string suffix label |
StringSuffixLevel | Returns or sets the string suffix level |
StringSuffixX | Returns or sets the string suffix x |
StringSuffixY | Returns or sets the string suffix y |
StringSuffixZ | Returns or sets the string suffix z |
Style | Returns the NXOpen.Annotations.StyleBuilder for the annotation |
Tag | Returns the Tag for this object. |
Title | Returns or sets the str title |
ToggleI | Returns or sets the toggle i |
ToggleJ | Returns or sets the toggle j |
ToggleK | Returns or sets the toggle k |
ToggleLabel | Returns or sets the toggle label |
ToggleLevel | Returns or sets the toggle level |
ToggleX | Returns or sets the toggle x |
ToggleY | Returns or sets the toggle y |
ToggleZ | Returns or sets the toggle z |
TrackingCsys | Returns or sets the tracking csys |
TrackingPoint | Returns or sets the tracking point |
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. |
GetAttributeValues | Returns the attribute values |
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. |
SetAttributeValues | Sets the attribute values |
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¶
Category¶
-
CoordinateNoteBuilder.
Category
¶ Returns or sets the category
-------------------------------------
Getter Method
Signature
Category
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Category
Parameters: category (str) – New in version NX6.0.0.
License requirements: None.
DecimalPlace¶
-
CoordinateNoteBuilder.
DecimalPlace
¶ Returns or sets the decimal place for coordinate note display
-------------------------------------
Getter Method
Signature
DecimalPlace
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DecimalPlace
Parameters: decimalPlace (int) – New in version NX6.0.0.
License requirements: None.
Identifier¶
-
CoordinateNoteBuilder.
Identifier
¶ Returns or sets the identifier
-------------------------------------
Getter Method
Signature
Identifier
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Identifier
Parameters: identifier (str) – New in version NX6.0.0.
License requirements: None.
Revision¶
-
CoordinateNoteBuilder.
Revision
¶ Returns or sets the revision
-------------------------------------
Getter Method
Signature
Revision
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Revision
Parameters: revision (str) – New in version NX6.0.0.
License requirements: None.
StringPrefixI¶
-
CoordinateNoteBuilder.
StringPrefixI
¶ Returns or sets the string prefix i
-------------------------------------
Getter Method
Signature
StringPrefixI
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringPrefixI
Parameters: stringPrefixI (str) – New in version NX6.0.0.
License requirements: None.
StringPrefixJ¶
-
CoordinateNoteBuilder.
StringPrefixJ
¶ Returns or sets the string prefix j
-------------------------------------
Getter Method
Signature
StringPrefixJ
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringPrefixJ
Parameters: stringPrefixJ (str) – New in version NX6.0.0.
License requirements: None.
StringPrefixK¶
-
CoordinateNoteBuilder.
StringPrefixK
¶ Returns or sets the string prefix k
-------------------------------------
Getter Method
Signature
StringPrefixK
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringPrefixK
Parameters: stringPrefixK (str) – New in version NX6.0.0.
License requirements: None.
StringPrefixLabel¶
-
CoordinateNoteBuilder.
StringPrefixLabel
¶ Returns or sets the string prefix label
-------------------------------------
Getter Method
Signature
StringPrefixLabel
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringPrefixLabel
Parameters: stringPrefixLabel (str) – New in version NX6.0.0.
License requirements: None.
StringPrefixLevel¶
-
CoordinateNoteBuilder.
StringPrefixLevel
¶ Returns or sets the string prefix level
-------------------------------------
Getter Method
Signature
StringPrefixLevel
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringPrefixLevel
Parameters: stringPrefixLevel (str) – New in version NX6.0.0.
License requirements: None.
StringPrefixX¶
-
CoordinateNoteBuilder.
StringPrefixX
¶ Returns or sets the string prefix x
-------------------------------------
Getter Method
Signature
StringPrefixX
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringPrefixX
Parameters: stringPrefixX (str) – New in version NX6.0.0.
License requirements: None.
StringPrefixY¶
-
CoordinateNoteBuilder.
StringPrefixY
¶ Returns or sets the string prefix y
-------------------------------------
Getter Method
Signature
StringPrefixY
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringPrefixY
Parameters: stringPrefixY (str) – New in version NX6.0.0.
License requirements: None.
StringPrefixZ¶
-
CoordinateNoteBuilder.
StringPrefixZ
¶ Returns or sets the string prefix z
-------------------------------------
Getter Method
Signature
StringPrefixZ
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringPrefixZ
Parameters: stringPrefixZ (str) – New in version NX6.0.0.
License requirements: None.
StringSuffixI¶
-
CoordinateNoteBuilder.
StringSuffixI
¶ Returns or sets the string suffix i
-------------------------------------
Getter Method
Signature
StringSuffixI
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringSuffixI
Parameters: stringSuffixI (str) – New in version NX6.0.0.
License requirements: None.
StringSuffixJ¶
-
CoordinateNoteBuilder.
StringSuffixJ
¶ Returns or sets the string suffix j
-------------------------------------
Getter Method
Signature
StringSuffixJ
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringSuffixJ
Parameters: stringSuffixJ (str) – New in version NX6.0.0.
License requirements: None.
StringSuffixK¶
-
CoordinateNoteBuilder.
StringSuffixK
¶ Returns or sets the string suffix k
-------------------------------------
Getter Method
Signature
StringSuffixK
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringSuffixK
Parameters: stringSuffixK (str) – New in version NX6.0.0.
License requirements: None.
StringSuffixLabel¶
-
CoordinateNoteBuilder.
StringSuffixLabel
¶ Returns or sets the string suffix label
-------------------------------------
Getter Method
Signature
StringSuffixLabel
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringSuffixLabel
Parameters: stringSuffixLabel (str) – New in version NX6.0.0.
License requirements: None.
StringSuffixLevel¶
-
CoordinateNoteBuilder.
StringSuffixLevel
¶ Returns or sets the string suffix level
-------------------------------------
Getter Method
Signature
StringSuffixLevel
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringSuffixLevel
Parameters: stringSuffixLevel (str) – New in version NX6.0.0.
License requirements: None.
StringSuffixX¶
-
CoordinateNoteBuilder.
StringSuffixX
¶ Returns or sets the string suffix x
-------------------------------------
Getter Method
Signature
StringSuffixX
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringSuffixX
Parameters: stringSuffixX (str) – New in version NX6.0.0.
License requirements: None.
StringSuffixY¶
-
CoordinateNoteBuilder.
StringSuffixY
¶ Returns or sets the string suffix y
-------------------------------------
Getter Method
Signature
StringSuffixY
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringSuffixY
Parameters: stringSuffixY (str) – New in version NX6.0.0.
License requirements: None.
StringSuffixZ¶
-
CoordinateNoteBuilder.
StringSuffixZ
¶ Returns or sets the string suffix z
-------------------------------------
Getter Method
Signature
StringSuffixZ
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StringSuffixZ
Parameters: stringSuffixZ (str) – New in version NX6.0.0.
License requirements: None.
Title¶
-
CoordinateNoteBuilder.
Title
¶ Returns or sets the str title
-------------------------------------
Getter Method
Signature
Title
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Title
Parameters: title (str) – New in version NX6.0.0.
License requirements: None.
ToggleI¶
-
CoordinateNoteBuilder.
ToggleI
¶ Returns or sets the toggle i
-------------------------------------
Getter Method
Signature
ToggleI
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToggleI
Parameters: toggleI (bool) – New in version NX6.0.0.
License requirements: None.
ToggleJ¶
-
CoordinateNoteBuilder.
ToggleJ
¶ Returns or sets the toggle j
-------------------------------------
Getter Method
Signature
ToggleJ
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToggleJ
Parameters: toggleJ (bool) – New in version NX6.0.0.
License requirements: None.
ToggleK¶
-
CoordinateNoteBuilder.
ToggleK
¶ Returns or sets the toggle k
-------------------------------------
Getter Method
Signature
ToggleK
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToggleK
Parameters: toggleK (bool) – New in version NX6.0.0.
License requirements: None.
ToggleLabel¶
-
CoordinateNoteBuilder.
ToggleLabel
¶ Returns or sets the toggle label
-------------------------------------
Getter Method
Signature
ToggleLabel
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToggleLabel
Parameters: toggleLabel (bool) – New in version NX6.0.0.
License requirements: None.
ToggleLevel¶
-
CoordinateNoteBuilder.
ToggleLevel
¶ Returns or sets the toggle level
-------------------------------------
Getter Method
Signature
ToggleLevel
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToggleLevel
Parameters: toggleLevel (bool) – New in version NX6.0.0.
License requirements: None.
ToggleX¶
-
CoordinateNoteBuilder.
ToggleX
¶ Returns or sets the toggle x
-------------------------------------
Getter Method
Signature
ToggleX
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToggleX
Parameters: toggleX (bool) – New in version NX6.0.0.
License requirements: None.
ToggleY¶
-
CoordinateNoteBuilder.
ToggleY
¶ Returns or sets the toggle y
-------------------------------------
Getter Method
Signature
ToggleY
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToggleY
Parameters: toggleY (bool) – New in version NX6.0.0.
License requirements: None.
ToggleZ¶
-
CoordinateNoteBuilder.
ToggleZ
¶ Returns or sets the toggle z
-------------------------------------
Getter Method
Signature
ToggleZ
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToggleZ
Parameters: toggleZ (bool) – New in version NX6.0.0.
License requirements: None.
TrackingCsys¶
-
CoordinateNoteBuilder.
TrackingCsys
¶ Returns or sets the tracking csys
-------------------------------------
Getter Method
Signature
TrackingCsys
Returns: Return type: NXOpen.CoordinateSystem
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TrackingCsys
Parameters: trackingCsys ( NXOpen.CoordinateSystem
) –New in version NX6.0.0.
License requirements: None.
TrackingPoint¶
-
CoordinateNoteBuilder.
TrackingPoint
¶ Returns or sets the tracking point
-------------------------------------
Getter Method
Signature
TrackingPoint
Returns: Return type: NXOpen.Point
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TrackingPoint
Parameters: trackingPoint ( NXOpen.Point
) –New in version NX6.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
CoordinateNoteBuilder.
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.