SuppressByExpressionBuilder Class¶
-
class
NXOpen.SuppressByExpressionBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.SuppressByExpressionBuilderTo create a new instance of this class, use
NXOpen.ExpressionCollection.CreateSuppressByExpressionBuilder()Default values.
Property Value SuppressAction CreateEach New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| FeatureList | Returns the feautre list. |
| SuppressAction | Returns or sets the suppress expression action. |
| Tag | Returns the Tag for this object. |
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¶
| SuppressByExpressionBuilderExpressionAction Enumeration | Represents the expression action type. |
Property Detail¶
FeatureList¶
-
SuppressByExpressionBuilder.FeatureList¶ Returns the feautre list.
For create each and create shared options, the selected features must not have pre existing suppress expressions. For delete each option, the selected features must have associated suppress expressions. If the expression is being shared by multiple features, the expression will be deleted only for the selected feature. For delete shared option, the complete group that shares a single expression must be selected.
-------------------------------------Getter Method
Signature
FeatureListReturns: Return type: NXOpen.Features.SelectFeatureListNew in version NX5.0.0.
License requirements: None.
SuppressAction¶
-
SuppressByExpressionBuilder.SuppressAction¶ Returns or sets the suppress expression action.
This enumeration decides the action to be taken on the selected group of features. A suppress expression can created per feature or as shared expression for a group of features. The expressions can be deleted individually for all features that have suppress expressions associated. For a group of features sharing an expression, the expression can also be deleted from the whole group.
-------------------------------------Getter Method
Signature
SuppressActionReturns: Return type: NXOpen.SuppressByExpressionBuilderExpressionActionNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SuppressActionParameters: suppressAction ( NXOpen.SuppressByExpressionBuilderExpressionAction) –New in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
SuppressByExpressionBuilder.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.