TextBasedElementBuilder Class¶
-
class
NXOpen.Motion.TextBasedElementBuilder¶ Bases:
NXOpen.Motion.MotionBuilderRepresents a
NXOpen.Motion.TextBasedElementBuilderbuilderTo create a new instance of this class, use
NXOpen.Motion.TextBasedElementCollection.CreateTextBasedElementBuilder()New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| Definition | Returns or sets the definition of text based element - MDF definition |
| DisplayScale | Returns or sets the icon display scale |
| GroupName | Returns or sets the group name |
| GroupType | Returns or sets the group type |
| Tag | Returns the Tag for this object. |
| Type | Returns or sets the text based element type - multiple possible values |
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. |
| 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¶
| TextBasedElementBuilderTypeChoices Enumeration | the text based element type - multiple values |
Property Detail¶
Definition¶
-
TextBasedElementBuilder.Definition¶ Returns or sets the definition of text based element - MDF definition
-------------------------------------Getter Method
Signature
DefinitionReturns: Return type: str New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
DefinitionParameters: definition (str) – New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
Type¶
-
TextBasedElementBuilder.Type¶ Returns or sets the text based element type - multiple possible values
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.Motion.TextBasedElementBuilderTypeChoicesNew in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
TypeParameters: elementType ( NXOpen.Motion.TextBasedElementBuilderTypeChoices) –New in version NX12.0.0.
License requirements: mechanisms (“MECHANISMS”)
Method Detail¶
Validate¶
-
TextBasedElementBuilder.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.