CreateComponentFrom3DSettingsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CreateComponentFrom3DSettingsBuilder Class

class `NXOpen.Layout2d.``CreateComponentFrom3DSettingsBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  Represents a `NXOpen.Layout2d.CreateComponentFrom3DSettingsBuilder`

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
AutomaticallyStartInsert2DComponentCommand | Returns or sets the settings to determines whether or not automatically start insert 2D component command
Color | Returns or sets the settings to specifies the 2D component curves color.
ColorOption | Returns or sets the settings to specifies how the color of the 2D component curves is defined.
CreateSingle2DComponentDefinition | Returns or sets the settings to determines whether or not create single 2D component definition
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
InheritSettingsFromCustomerDefault | Inherit Settings From Customer Default
InheritSettingsFromPreferences | Inherit Settings From Preference
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## AutomaticallyStartInsert2DComponentCommand

`CreateComponentFrom3DSettingsBuilder.``AutomaticallyStartInsert2DComponentCommand`

  Returns or sets the settings to determines whether or not automatically start insert 2D component command

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

  Getter Method

  Signature `AutomaticallyStartInsert2DComponentCommand`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AutomaticallyStartInsert2DComponentCommand`

  Parameters: | automaticallyStartInsert2DComponentCommand (bool) –

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

## Color

`CreateComponentFrom3DSettingsBuilder.``Color`

  Returns or sets the settings to specifies the 2D component curves color.

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

  Getter Method

  Signature `Color`

  Returns: |
  Return type: | int

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Color`

  Parameters: | color (int) –

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

## ColorOption

`CreateComponentFrom3DSettingsBuilder.``ColorOption`

  Returns or sets the settings to specifies how the color of the 2D component curves is defined.

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

  Getter Method

  Signature `ColorOption`

  Returns: |
  Return type: | `NXOpen.Display.DynamicSectionTypesCurveColorOption`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ColorOption`

  Parameters: | colorOption (`NXOpen.Display.DynamicSectionTypesCurveColorOption`) –

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

## CreateSingle2DComponentDefinition

`CreateComponentFrom3DSettingsBuilder.``CreateSingle2DComponentDefinition`

  Returns or sets the settings to determines whether or not create single 2D component definition

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

  Getter Method

  Signature `CreateSingle2DComponentDefinition`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CreateSingle2DComponentDefinition`

  Parameters: | createSingle2DComponentDefinition (bool) –

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

# Method Detail

## InheritSettingsFromCustomerDefault

`CreateComponentFrom3DSettingsBuilder.``InheritSettingsFromCustomerDefault`

  Inherit Settings From Customer Default

  Signature `InheritSettingsFromCustomerDefault()`

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

## InheritSettingsFromPreferences

`CreateComponentFrom3DSettingsBuilder.``InheritSettingsFromPreferences`

  Inherit Settings From Preference

  Signature `InheritSettingsFromPreferences()`

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

## Validate

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