SchematicDocument.name Property

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

Description

This property gets and sets the name of the document. You can only set the name of a document before the document is saved for the first time. You can use the isSaved property to determine this. If the document has not been saved and the name is changed, the specified name will be the default name shown in the Save dialog, which the user can modify before saving the document.

If the file has been saved, this property behaves as read-only. Setting the name will fail because the name is controlled by the DataFile associated with this document. However, you can edit the name of the DataFile, which you can obtain by using the dataFile property of the document.

Syntax

# Get the value of the property.
propertyValue = schematicDocument_var.name

# Set the value of the property.
schematicDocument_var.name = propertyValue

#include <Electron/SchematicDocument/SchematicDocument.h>

// Get the value of the property.
string propertyValue = schematicDocument_var->name();

// Set the value of the property, where value_var is a string.
bool returnValue = schematicDocument_var->name(value_var);

// Get the value of the property.
propertyValue = schematicDocument_var.name;

// Set the value of the property.
schematicDocument_var.name = propertyValue;

Property Value

Version