ITextDocument.SaveAs Method (String, Boolean)

Saves the contents of the TextBuffer to the specified file path.

Namespace:  Microsoft.VisualStudio.Text
Assembly:  Microsoft.VisualStudio.Text.Data (in Microsoft.VisualStudio.Text.Data.dll)

Syntax

'Declaration
Sub SaveAs ( _
    filePath As String, _
    overwrite As Boolean _
)
void SaveAs(
    string filePath,
    bool overwrite
)
void SaveAs(
    String^ filePath, 
    bool overwrite
)
abstract SaveAs : 
        filePath:string * 
        overwrite:bool -> unit
function SaveAs(
    filePath : String, 
    overwrite : boolean
)

Parameters

  • filePath
    Type: String

    The name of the new file.

  • overwrite
    Type: Boolean

    true if filePath should be overwritten if it exists, otherwise false.

Exceptions

Exception Condition
InvalidOperationException

This object is in the middle of raising events.

ArgumentNullException

filePath is null.

UnauthorizedAccessException

An access error occurred during file save.

IOException

An I/O error occurred (including an error caused by attempting to overwrite an existing file when overwrite is false).

ObjectDisposedException

This object has been disposed.

Remarks

If the save operation is successful, FilePath is set to filePath, and IsDirty is set to false. If the save operation fails, FilePath and IsDirty remains unchanged.

.NET Framework Security

See Also

Reference

ITextDocument Interface

SaveAs Overload

Microsoft.VisualStudio.Text Namespace