StringTestBuilder Class¶
-
class
NXOpen.GeometricUtilities.
StringTestBuilder
¶ Bases:
NXOpen.Builder
Represents a
StringTestBuilder
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
Combo | Returns or sets the combo |
ComboIti | Returns or sets the combo iti |
IconKeyin | Returns or sets the icon keyin |
Keyin | Returns or sets the keyin |
KeyinIti | Returns or sets the keyin iti |
List | Returns or sets the list |
ListIti | Returns or sets the list iti |
Tag | Returns the Tag for this object. |
Wide | Returns or sets the wide |
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. |
Property Detail¶
Combo¶
-
StringTestBuilder.
Combo
¶ Returns or sets the combo
-------------------------------------
Getter Method
Signature
Combo
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Combo
Parameters: combo (str) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ComboIti¶
-
StringTestBuilder.
ComboIti
¶ Returns or sets the combo iti
-------------------------------------
Getter Method
Signature
ComboIti
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ComboIti
Parameters: comboIti (str) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
IconKeyin¶
-
StringTestBuilder.
IconKeyin
¶ Returns or sets the icon keyin
-------------------------------------
Getter Method
Signature
IconKeyin
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IconKeyin
Parameters: iconKeyin (str) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Keyin¶
-
StringTestBuilder.
Keyin
¶ Returns or sets the keyin
-------------------------------------
Getter Method
Signature
Keyin
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Keyin
Parameters: keyin (str) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
KeyinIti¶
-
StringTestBuilder.
KeyinIti
¶ Returns or sets the keyin iti
-------------------------------------
Getter Method
Signature
KeyinIti
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KeyinIti
Parameters: keyinIti (str) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
List¶
-
StringTestBuilder.
List
¶ Returns or sets the list
-------------------------------------
Getter Method
Signature
List
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
List
Parameters: list (str) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ListIti¶
-
StringTestBuilder.
ListIti
¶ Returns or sets the list iti
-------------------------------------
Getter Method
Signature
ListIti
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ListIti
Parameters: listIti (str) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Wide¶
-
StringTestBuilder.
Wide
¶ Returns or sets the wide
-------------------------------------
Getter Method
Signature
Wide
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Wide
Parameters: wide (str) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Method Detail¶
Validate¶
-
StringTestBuilder.
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.