DocumentStructureBuilder Class

class NXOpen.AME.DocumentStructureBuilder

Bases: NXOpen.Builder

Class to define Document Structure

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

New in version NX11.0.0.

Properties

Property	Description
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.
GetDocumentStructureObject	Get the Document Structure object for a given Document type.
GetObject	Returns the object currently being edited by this builder.
ResetDocumentStructure	Reset the Document Structure for a given Document type.
ResetToDefault	Reset the Document Structure 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

GetDocumentStructureObject

DocumentStructureBuilder.GetDocumentStructureObject

Get the Document Structure object for a given Document type.

Signature GetDocumentStructureObject(documetType)

Parameters:documetType (NXOpen.AME.DocumentType) – Returns: Return type:NXOpen.AME.DB.DocumentStructure

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ResetDocumentStructure

DocumentStructureBuilder.ResetDocumentStructure

Reset the Document Structure for a given Document type.

Signature ResetDocumentStructure(documetType)

Parameters:documetType (NXOpen.AME.DocumentType) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ResetToDefault

DocumentStructureBuilder.ResetToDefault

Reset the Document Structure for all Document types.

Signature ResetToDefault()

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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