PmiCustomSymbolBuilder Class¶
-
class
NXOpen.Annotations.PmiCustomSymbolBuilder¶ Bases:
NXOpen.Annotations.BaseCustomSymbolBuilderRepresents builder for PMI Custom Symbol
To create a new instance of this class, use
NXOpen.Annotations.CustomSymbolCollection.CreatePmiCustomSymbolBuilder()New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| Angle | Returns the angle |
| AnnotationPreference | Returns or sets the enum annot pref. |
| AssociatedObjects | Returns the select associated objects |
| ControlledNoteTitle | Returns or sets the controlled note title |
| GeometryPreference | Returns or sets the enum geom pref. |
| HorizontalFlip | Returns or sets the horizontal flip |
| Integer | Returns or sets the integer value of selected text |
| IsPartSymbol | Returns or sets the is part symbol. |
| Leader | Returns the NXOpen.Annotations.LeaderBuilder for the annotation |
| LockStatus | Returns or sets the get symbol lock property |
| MasterSymbolName | Returns or sets the master symbol Name. |
| MasterSymbolPath | Returns or sets the master symbol path. |
| Origin | Returns the origin |
| PartiallyControlledNoteTitle | Returns or sets the partially controlled note title |
| Real | Returns or sets the real value of selected text |
| Scale | Returns the scale |
| SmashSymbol | Returns or sets the smash symbol |
| Style | Returns the style builder |
| Tag | Returns the Tag for this object. |
| Texts | Returns the texts |
| VerticalFlip | Returns or sets the vertical flip |
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. |
| GetArbitraryNoteTitle | Returns the arbitrary note value in an array. |
| 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. |
| GetSymbol | Returns the custom symbol |
| SelectPartSymbol | Selects part custom symbol |
| SelectSymbol | Selects custom symbol |
| SelectText | Selects the node index of custom symbol text |
| SetArbitraryNoteTitle | Sets the arbitrary note value. |
| 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¶
-
PmiCustomSymbolBuilder.AssociatedObjects¶ Returns the select associated objects
-------------------------------------Getter Method
Signature
AssociatedObjectsReturns: Return type: NXOpen.Annotations.AssociatedObjectsBuilderNew in version NX7.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
PmiCustomSymbolBuilder.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.