ComponentSettingsBuilder Class

class NXOpen.Layout2d.ComponentSettingsBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a NXOpen.Layout2d.ComponentSettingsBuilder This builder stores the information of the 2D Component settings

New in version NX10.0.0.

Properties

Property Description
AutomaticUpdate Returns or sets the flag to do automatic update or not
KeepEditedPartsOpen Returns or sets the flag indicating whether to keep edited parts open or not
ShowAnnotations Returns or sets the flag to show annotations or not
ShowDimensions Returns or sets the flag to show dimensions or not
ShowReferenceGeometry Returns or sets the flag to show reference geometry or not
Tag Returns the Tag for this object.

Methods

Method Description
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

AutomaticUpdate

ComponentSettingsBuilder.AutomaticUpdate

Returns or sets the flag to do automatic update or not

-------------------------------------

Getter Method

Signature AutomaticUpdate

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AutomaticUpdate

Parameters:toggle (bool) –

New in version NX10.0.0.

License requirements: nx_layout (“NX Layout”)

KeepEditedPartsOpen

ComponentSettingsBuilder.KeepEditedPartsOpen

Returns or sets the flag indicating whether to keep edited parts open or not

-------------------------------------

Getter Method

Signature KeepEditedPartsOpen

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature KeepEditedPartsOpen

Parameters:toggle (bool) –

New in version NX11.0.0.

License requirements: nx_layout (“NX Layout”)

ShowAnnotations

ComponentSettingsBuilder.ShowAnnotations

Returns or sets the flag to show annotations or not

-------------------------------------

Getter Method

Signature ShowAnnotations

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowAnnotations

Parameters:toggle (bool) –

New in version NX10.0.0.

License requirements: nx_layout (“NX Layout”)

ShowDimensions

ComponentSettingsBuilder.ShowDimensions

Returns or sets the flag to show dimensions or not

-------------------------------------

Getter Method

Signature ShowDimensions

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowDimensions

Parameters:toggle (bool) –

New in version NX10.0.0.

License requirements: nx_layout (“NX Layout”)

ShowReferenceGeometry

ComponentSettingsBuilder.ShowReferenceGeometry

Returns or sets the flag to show reference geometry or not

-------------------------------------

Getter Method

Signature ShowReferenceGeometry

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowReferenceGeometry

Parameters:toggle (bool) –

New in version NX10.0.0.

License requirements: nx_layout (“NX Layout”)

Method Detail

Validate

ComponentSettingsBuilder.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.