•  

OpenDocumentFile Method (String)

Opens a document from disk.

Namespace: Autodesk.Revit.ApplicationServices
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since:  2013

Syntax

C#
public Document OpenDocumentFile(
	string fileName
)
Visual Basic
Public Function OpenDocumentFile ( _
	fileName As String _
) As Document
Visual C++
public:
Document^ OpenDocumentFile(
	String^ fileName
)

Parameters

fileName
Type: SystemString
The file to be opened.

Return Value

The opened document.

Remarks

This method opens the document into memory but does not make it visible to the user in any way.

Exceptions

ExceptionCondition
Autodesk.Revit.ExceptionsArgumentException The fileName to be opened is empty.
Autodesk.Revit.ExceptionsArgumentNullException A non-optional argument was null
Autodesk.Revit.ExceptionsCannotOpenBothCentralAndLocalException Cannot open the local model and the central model in the same Revit session. You can close one to open the other in the same Revit session.
Autodesk.Revit.ExceptionsCentralModelException Revit encountered serious errors while trying to open the central model.
Autodesk.Revit.ExceptionsCorruptModelException There are too many corrupt elements to open this model.
Autodesk.Revit.ExceptionsFileAccessException File cannot be opened in Revit LT because it was last saved in a version of Revit prior to 8.1. -or- File has an invalid extension. Try changing the file's extension and opening it again.
Autodesk.Revit.ExceptionsFileNotFoundException The fileName to be opened doesn't exist. -or- File Not Found
Autodesk.Revit.ExceptionsInsufficientResourcesException This computer does not have enough memory, disk space, or other necessary resource to open the model.
Autodesk.Revit.ExceptionsInvalidOperationException Open is temporarily disabled. -or- The document can not be opened.
Autodesk.Revit.ExceptionsOperationCanceledException Opening was canceled by the user or by an API event callback.

See Also