EditComponentSettingsBuilder Class¶
-
class
NXOpen.Layout2d.
EditComponentSettingsBuilder
¶ Bases:
NXOpen.Drafting.BaseEditSettingsBuilder
Represents a
NXOpen.Layout2d.EditComponentSettingsBuilder
builder.It provides an interface for editing layout2d component settings. The committed object is the component with the new settings To create a new instance of this class, use
NXOpen.Drafting.SettingsManager.CreateLayout2dEditComponentSettingsBuilder()
New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
ComponentSettings | Returns the 2D Component settings block builder which holds the component settings builder |
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. |
InheritSettingsFromCustomerDefault | Inherit Settings From Customer Default |
InheritSettingsFromPreferences | Inherit Settings From Preference |
InheritSettingsFromSelectedObject | Inherit Settings From Selected Objects |
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. |
Property Detail¶
ComponentSettings¶
-
EditComponentSettingsBuilder.
ComponentSettings
¶ Returns the 2D Component settings block builder which holds the component settings builder
-------------------------------------
Getter Method
Signature
ComponentSettings
Returns: Return type: NXOpen.Layout2d.ComponentSettingsBlockBuilder
New in version NX10.0.0.
License requirements: None.
Method Detail¶
InheritSettingsFromCustomerDefault¶
-
EditComponentSettingsBuilder.
InheritSettingsFromCustomerDefault
¶ Inherit Settings From Customer Default
Signature
InheritSettingsFromCustomerDefault()
New in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
InheritSettingsFromPreferences¶
-
EditComponentSettingsBuilder.
InheritSettingsFromPreferences
¶ Inherit Settings From Preference
Signature
InheritSettingsFromPreferences()
New in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
InheritSettingsFromSelectedObject¶
-
EditComponentSettingsBuilder.
InheritSettingsFromSelectedObject
¶ Inherit Settings From Selected Objects
Signature
InheritSettingsFromSelectedObject(selectedObject)
Parameters: selectedObject ( NXOpen.NXObject
) – The selected 2D Component object. None is not allowed.New in version NX10.0.0.
License requirements: nx_layout (“NX Layout”)
Validate¶
-
EditComponentSettingsBuilder.
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.