ITextDocument.SaveAs Method (String, Boolean, Boolean, IContentType)
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, _
createFolder As Boolean, _
newContentType As IContentType _
)
void SaveAs(
string filePath,
bool overwrite,
bool createFolder,
IContentType newContentType
)
void SaveAs(
String^ filePath,
bool overwrite,
bool createFolder,
IContentType^ newContentType
)
abstract SaveAs :
filePath:string *
overwrite:bool *
createFolder:bool *
newContentType:IContentType -> unit
function SaveAs(
filePath : String,
overwrite : boolean,
createFolder : boolean,
newContentType : IContentType
)
Parameters
filePath
Type: System.StringThe name of the new file.
overwrite
Type: System.Booleantrue if filePath should be overwritten if it exists, otherwise false.
createFolder
Type: System.Booleantrue if the folder containing filePath should be created if it does not exist, otherwise false.
newContentType
Type: Microsoft.VisualStudio.Utilities.IContentTypeThe new IContentType.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | This object is in the middle of raising events. |
| ArgumentNullException | filePath or newContentType is nulla null reference (Nothing in Visual Basic). |
| 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 is successful, FilePath is set to filePath, and IsDirty is set to false. If the save fails, FilePath and IsDirty remains unchanged.
The order of events raised as a result of a successful file SaveAs operation is FileActionOccurred followed by ContentTypeChanged.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.