Document Object

Derived from: Base Object
Defined in namespace "adsk::core" and the header file is <Core/Application/Document.h>

Description

Object that represents an open document. This is the base class for all document types.

Methods

Name Description
activate Causes this document to become the active document in the user interface.
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().
close Closes this document.
save 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.
saveAs Performs a Save As on this document. This saves the currently open document to the specified location and this document becomes the saved document. If this is a new document that has never been saved you must use the SaveAs method in order to specify the location and name. You can determine if the document has been saved by checking the value of the isSaved property.
saveMilestone Saves the document as a new milestone. This method is not applicable when saving a document for the first time. In that case, you must use the SaveAs method. You can determine if a document has been saved by checking the value of the isSaved property.
updateAllReferences Updates all out of date xref(s) and/or syncs all out of sync context(s). This is equivalent to clicking the "Out of Date" button in the Quick Access Toolbar to update all out of date xref(s) and/or out of sync context(s).

Properties

Name Description
allDocumentReferences Returns a collection containing all of the documents referenced directly by this document and those referenced by all sub-assemblies.
attributes Returns the collection of attributes associated with this document.
creationId Returns the creation ID of this document. When a new document is created, Fusion assigns it a creation ID that will remain constant for the life of the document. The ID that is assigned is unique. However, it's possible that more than one document can have the same ID. This happens in the case where a document is copied. In this case a new document is created but an existing document is copied. It's only when a new document is created that a creation ID is generated and assigned.

Using this ID can be useful in cases where the save of a new document is started and you can use this ID to match the completion of the save operation on the cloud to the original document.
dataFile Gets the DataFile that represents this document in A360.
designDataFile Gets the DesignDataFile that represents this document in A360.
documentReferences Returns a collection containing the documents directly referenced by this document.
isActive Gets if this document is the active document in the user interface.
isModified Property that indicates if the document has been modified since it was last saved.
isSaved Property that indicates if this document has been saved or not. The initial save of a document requires that the name and location be specified and requires the saveAs method to be used. If the document has been saved then the save method can be used to save changes made.
isUpToDate Indicates if any xref(s) and/or context(s) in the assembly are out of date. This is the API equivalent to the "Out of Date" notification displayed in the Quick Access Toolbar.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
isVisible Gets if a currently open document is open as visible.
name 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.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():
parent Returns the parent Application object.
products Returns the products associated with this document.
version Returns the Fusion version this document was last saved with.

Accessed From

Application.activeDocument, CAM.parentDocument, Design.parentDocument, DocumentEventArgs.document, DocumentReference.parentDocument, DocumentReference.referencedDocument, Documents.add, Documents.item, Documents.open, Drawing.parentDocument, FlatPatternProduct.parentDocument, ImportManager.importToNewDocument, Product.parentDocument, Viewport.parentDocument, WorkingModel.parentDocument

Derived Classes

DrawingDocument, FusionDocument

Samples

Name Description
Loft Feature API Sample Demonstrates creating a new loft feature.

Version

Introduced in version August 2014