Documents.open Method

Parent Object: Documents
Defined in namespace "adsk::core" and the header file is <Core/Application/Documents.h>

Description

Opens an item that has previously been saved.

Syntax

"documents_var" is a variable referencing a Documents object.
# Uses no optional arguments.
returnValue = documents_var.open(dataFile)

# Uses optional arguments.
returnValue = documents_var.open(dataFile, visible)
"documents_var" is a variable referencing a Documents object.

#include <Core/Application/Documents.h>

// Uses no optional arguments.
returnValue = documents_var->open(dataFile);

// Uses optional arguments.
returnValue = documents_var->open(dataFile, visible);

Return Value

Type Description
Document Returns the open document or null if the open failed.

Parameters

Name Type Description
dataFile DataFile The item to open.
visible boolean Specifies if the document should be opened visibly or not.

This is an optional argument whose default value is True.

Samples

Name Description
File Open Sample Demonstrates how to open files using the Open API and OpenUsingContext API. The sample shows how to open a file at the tip (latest version) and how to open historical versions of a file. It uses the Open API to open files at tip and iterate through historical versions, and the OpenUsingContext API to open file using FileOpenContext .

Version

Introduced in version March 2015