Skip to content

UIDocument.SaveAs(UISaveAsOptions)

Public Class

Saves the document to a file name obtained from the Revit user optionally prompting the user to overwrite file if it exists.

Namespace: Autodesk.Revit.UI

Assembly: RevitAPIUI (in RevitAPIUI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public void SaveAs(
UISaveAsOptions options
)

Parameters

options UISaveAsOptions

UI options for the SaveAs operation.

Exceptions

Exception

Condition


ArgumentNullException

A non-optional argument was null


ForbiddenForDynamicUpdateException

SaveAs may not be called during dynamic update.


InvalidOperationException

Is not a primary document, it is a linked document. -or- SaveAs is temporarily disabled. -or- Thrown if there are any transactions, sub-transactions or transaction groups which were opened by the API code, and not closed. All of these items must be handled before attempting to save the document.


OperationCanceledException

Thrown if saving is cancelled by an external application during ‘DocumentSavingAs’ event.


Remarks

This method may not be called unless all transactions, sub-transactions, and transaction groups that were opened by the API code were closed.

That also implies that this method cannot be called during dynamic updates.