EditSettingsBuilder Class¶
-
class
NXOpen.Annotations.EditSettingsBuilder¶ Bases:
NXOpen.Drafting.BaseEditSettingsBuilderthe edit settings builder
To create a new instance of this class, use
NXOpen.Drafting.SettingsManager.CreateAnnotationEditSettingsBuilder()New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| AnnotationStyle | Returns the annotation style builder |
| DrawingFormatTitle | Returns the drawing format title block builder |
| Tag | Returns the Tag for this object. |
| ViewProjectedArrowSettings | Returns the projected view arrow Settings builder |
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 |
| InheritSettingsFromSelectedObjects | 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¶
AnnotationStyle¶
-
EditSettingsBuilder.AnnotationStyle¶ Returns the annotation style builder
-------------------------------------Getter Method
Signature
AnnotationStyleReturns: Return type: NXOpen.Annotations.StyleBuilderNew in version NX9.0.0.
License requirements: None.
DrawingFormatTitle¶
-
EditSettingsBuilder.DrawingFormatTitle¶ Returns the drawing format title block builder
-------------------------------------Getter Method
Signature
DrawingFormatTitleReturns: Return type: NXOpen.Annotations.DrawingFormatTitleBuilderNew in version NX9.0.0.
License requirements: None.
ViewProjectedArrowSettings¶
-
EditSettingsBuilder.ViewProjectedArrowSettings¶ Returns the projected view arrow Settings builder
-------------------------------------Getter Method
Signature
ViewProjectedArrowSettingsReturns: Return type: NXOpen.Drawings.ViewProjectedArrowSettingsBuilderNew in version NX9.0.0.
License requirements: None.
Method Detail¶
InheritSettingsFromCustomerDefault¶
-
EditSettingsBuilder.InheritSettingsFromCustomerDefault¶ Inherit Settings From Customer Default
Signature
InheritSettingsFromCustomerDefault()New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
InheritSettingsFromPreferences¶
-
EditSettingsBuilder.InheritSettingsFromPreferences¶ Inherit Settings From Preference
Signature
InheritSettingsFromPreferences()New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
InheritSettingsFromSelectedObjects¶
-
EditSettingsBuilder.InheritSettingsFromSelectedObjects¶ Inherit Settings From Selected Objects
Signature
InheritSettingsFromSelectedObjects(selectedObject)Parameters: selectedObject ( NXOpen.DisplayableObject) – The selected annotation or table instance object. None is not allowed.New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
Validate¶
-
EditSettingsBuilder.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.