FormSheetSettingsBuilder Class

class NXOpen.AME.FormSheetSettingsBuilder

Bases: NXOpen.Builder

JA class for the Form Sheet Settings dialog

To create a new instance of this class, use NXOpen.AME.AMEManager.CreateFormSheetSettingsBuilder()

New in version NX12.0.0.

Properties

Property Description
Tag Returns the Tag for this object.

Methods

Method Description
AddFormSheetMapping Adds form sheet mapping with document type
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.
ResetFormSheetMapping Reset the form sheet mapping for a given document type.
ResetToDefault Reset the form sheet mapping for all document types.
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.

Method Detail

AddFormSheetMapping

FormSheetSettingsBuilder.AddFormSheetMapping

Adds form sheet mapping with document type

Signature AddFormSheetMapping(documentType, formSheetName)

Parameters:

New in version NX12.0.0.

License requirements: None.

ResetFormSheetMapping

FormSheetSettingsBuilder.ResetFormSheetMapping

Reset the form sheet mapping for a given document type.

Signature ResetFormSheetMapping(documentType)

Parameters:documentType (NXOpen.AME.DocumentType) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ResetToDefault

FormSheetSettingsBuilder.ResetToDefault

Reset the form sheet mapping for all document types.

Signature ResetToDefault()

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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