Document.name Property

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 = document_var.name

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

#include <Core/Application/Document.h>

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

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

Property Value

Version