SchematicDocument.save Method

Parent Object: SchematicDocument

PreviewThis functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.


Defined in namespace "adsk::electron" and the header file is <Electron/SchematicDocument/SchematicDocument.h>

Description

Saves a version of the current document. You must use the SaveAs method the first time a document is saved. You can determine if a document has been saved by checking the value of the isSaved property.

Saving a document is not supported within any of the Command related events. When a command is running, a transaction is open, and saving a document cannot be transacted and, as a result, cannot be contained within a command transaction.

Syntax

"schematicDocument_var" is a variable referencing a SchematicDocument object.

returnValue = schematicDocument_var.save(description)
"schematicDocument_var" is a variable referencing a SchematicDocument object.

#include <Electron/SchematicDocument/SchematicDocument.h>

returnValue = schematicDocument_var->save(description);
"schematicDocument_var" is a variable referencing a SchematicDocument object.

returnValue = schematicDocument_var.save(description);

Return Value

Type Description
boolean Returns true if saving the document was successful. This will also return true in the case when save is called and the document has not been modified since the last save. In this case nothing needs to be saved, so the call is still considered successful because the correct action is to do nothing.

Parameters

Name Type Description
description string The version description for this document

Version

Introduced in version September 2026