SettingsBuilder Class

class NXOpen.Drawings.SettingsBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a Drawings.SettingsBuilder.

This class queries and sets settings.

New in version NX11.0.0.

Properties

Property	Description
AnnotationSettings	Returns the Annotation settings builder which stores the annotation settings
ConversionSettings	Returns the Component settings builder which stores the component settings
Tag	Returns the Tag for this object.
ViewSettings	Returns the View settings builder which stores the view settings

Methods

Method	Description
SaveConfigurationFile	API used to save settings data
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

AnnotationSettings

SettingsBuilder.AnnotationSettings

Returns the Annotation settings builder which stores the annotation settings

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

Getter Method

Signature AnnotationSettings

Returns: Return type:NXOpen.Drawings.AnnotationSettingsBuilder

New in version NX11.0.0.

License requirements: None.

ConversionSettings

SettingsBuilder.ConversionSettings

Returns the Component settings builder which stores the component settings

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

Getter Method

Signature ConversionSettings

Returns: Return type:NXOpen.Drawings.ConversionProcessSettingsBuilder

New in version NX11.0.0.

License requirements: None.

ViewSettings

SettingsBuilder.ViewSettings

Returns the View settings builder which stores the view settings

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

Getter Method

Signature ViewSettings

Returns: Return type:NXOpen.Drawings.ViewSettingsBuilder

New in version NX11.0.0.

License requirements: None.

Method Detail

SaveConfigurationFile

SettingsBuilder.SaveConfigurationFile

API used to save settings data

Signature SaveConfigurationFile(saveAsFile)

Parameters:saveAsFile (str) –

New in version NX11.0.0.

License requirements: drafting (“DRAFTING”)

Validate

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