ITextDocument::SaveAs Method (String^, Boolean, Boolean)

Visual Studio 2015
 

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)

C#
C++
F#
VB
Copy 
void SaveAs(
	String^ filePath,
	bool overwrite,
	bool createFolder
)

Parameters

filePath
Type: System::String^

The name of the new file.

overwrite
Type: System::Boolean

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

createFolder
Type: System::Boolean

true if the folder containing filePath should be created if it does not exist, otherwise false.

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.

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.

Return to top
Show: