ColorFeatureBuilder Class¶
-
class
NXOpen.Features.ColorFeatureBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Features.ColorFeatureBuilderRepresents a color feature builder.The color feature does not create a feature, but assists user to assign color to selected features. To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateColorFeatureBuilder()Default values.
Property Value SpecifyColor SpecifyColor StoreColor 1 New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| Color | Returns or sets the color |
| SelectFeature | Returns the features to color |
| SpecifyColor | Returns or sets the specified color option. |
| StoreColor | Returns or sets the save color property to feature |
| 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¶
| ColorFeatureBuilderOperationType Enumeration | specify color or remove color type |
Property Detail¶
Color¶
-
ColorFeatureBuilder.Color¶ Returns or sets the color
-------------------------------------Getter Method
Signature
ColorReturns: Return type: Id New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ColorParameters: color (Id) – New in version NX8.5.0.
License requirements: None.
SelectFeature¶
-
ColorFeatureBuilder.SelectFeature¶ Returns the features to color
-------------------------------------Getter Method
Signature
SelectFeatureReturns: Return type: NXOpen.Features.SelectFeatureListNew in version NX8.5.0.
License requirements: None.
SpecifyColor¶
-
ColorFeatureBuilder.SpecifyColor¶ Returns or sets the specified color option.
If the option is
NXOpen.Features.ColorFeatureBuilderOperationType.SpecifyColor, assign valid color to feature. If the returned value isNXOpen.Features.ColorFeatureBuilderOperationType.NoColor, remove color from feature-------------------------------------Getter Method
Signature
SpecifyColorReturns: Return type: NXOpen.Features.ColorFeatureBuilderOperationTypeNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SpecifyColorParameters: specifyColor ( NXOpen.Features.ColorFeatureBuilderOperationType) –New in version NX8.5.0.
License requirements: None.
StoreColor¶
-
ColorFeatureBuilder.StoreColor¶ Returns or sets the save color property to feature
-------------------------------------Getter Method
Signature
StoreColorReturns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StoreColorParameters: hasStoreColor (bool) – New in version NX8.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
ColorFeatureBuilder.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.