ColorFeatureGroupBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ColorFeatureGroupBuilder Class

class `NXOpen.Features.``ColorFeatureGroupBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Features.ColorFeatureGroupBuilder` Represents a color feature group builder.

  The color feature group does not create a feature, but assists user to assign color to selected feature groups. To create a new instance of this class, use `NXOpen.Features.FeatureCollection.CreateColorFeatureGroupBuilder()`

  Default values.

  Property | Value
  --- | ---
  Operation | SpecifyColor
  Process | NewFeatures

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
Color | Returns or sets the color
Operation | Returns or sets the color operation option.
Process | Returns or sets the property to set color for new features only or set color and apply to all members
SelectFeature | Returns the features to color
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

ColorFeatureGroupBuilderOperationType Enumeration | specify color or remove color type
ColorFeatureGroupBuilderProcessType Enumeration | set color for new features only or set color and apply to all members

# Property Detail

## Color

`ColorFeatureGroupBuilder.``Color`

  Returns or sets the color

  `-------------------------------------`

  Getter Method

  Signature `Color`

  Returns: |
  Return type: | Id

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Color`

  Parameters: | color (Id) –

  New in version NX8.5.0.

  License requirements: None.

## Operation

`ColorFeatureGroupBuilder.``Operation`

  Returns or sets the color operation option.

  If the option is `NXOpen.Features.ColorFeatureGroupBuilderOperationType.SpecifyColor`, assign valid color to feature. If the returned value is `NXOpen.Features.ColorFeatureGroupBuilderOperationType.NoColor`, remove color from feature

  `-------------------------------------`

  Getter Method

  Signature `Operation`

  Returns: |
  Return type: | `NXOpen.Features.ColorFeatureGroupBuilderOperationType`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Operation`

  Parameters: | colorOperation (`NXOpen.Features.ColorFeatureGroupBuilderOperationType`) –

  New in version NX8.5.0.

  License requirements: None.

## Process

`ColorFeatureGroupBuilder.``Process`

  Returns or sets the property to set color for new features only or set color and apply to all members

  `-------------------------------------`

  Getter Method

  Signature `Process`

  Returns: |
  Return type: | `NXOpen.Features.ColorFeatureGroupBuilderProcessType`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Process`

  Parameters: | processType (`NXOpen.Features.ColorFeatureGroupBuilderProcessType`) –

  New in version NX8.5.0.

  License requirements: None.

## SelectFeature

`ColorFeatureGroupBuilder.``SelectFeature`

  Returns the features to color

  `-------------------------------------`

  Getter Method

  Signature `SelectFeature`

  Returns: |
  Return type: | `NXOpen.Features.SelectFeatureList`

  New in version NX8.5.0.

  License requirements: None.

# Method Detail

## Validate

`ColorFeatureGroupBuilder.``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.