DocumentBase.SaveAs2 Method

Reference

Definition

Namespace:: Microsoft.Office.Tools.Word

Assembly:: Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Saves the document with a new name or format. Some of the arguments for this method correspond to the options in the Save As dialog box.

public void SaveAs2 (ref object fileName, ref object fileFormat, ref object lockComments, ref object password, ref object addToRecentFiles, ref object writePassword, ref object readOnlyRecommended, ref object embedTrueTypeFonts, ref object saveNativePictureFormat, ref object saveFormsData, ref object saveAsAOCELetter, ref object encoding, ref object insertLineBreaks, ref object allowSubstitutions, ref object lineEnding, ref object addBiDiMarks, ref object compatibilityMode);

member this.SaveAs2 : obj * obj * obj * obj * obj * obj * obj * obj * obj * obj * obj * obj * obj * obj * obj * obj * obj -> unit

Public Sub SaveAs2 (Optional ByRef fileName As Object, Optional ByRef fileFormat As Object, Optional ByRef lockComments As Object, Optional ByRef password As Object, Optional ByRef addToRecentFiles As Object, Optional ByRef writePassword As Object, Optional ByRef readOnlyRecommended As Object, Optional ByRef embedTrueTypeFonts As Object, Optional ByRef saveNativePictureFormat As Object, Optional ByRef saveFormsData As Object, Optional ByRef saveAsAOCELetter As Object, Optional ByRef encoding As Object, Optional ByRef insertLineBreaks As Object, Optional ByRef allowSubstitutions As Object, Optional ByRef lineEnding As Object, Optional ByRef addBiDiMarks As Object, Optional ByRef compatibilityMode As Object)

Parameters

fileName: Object

The name for the document. The default is the current folder and file name. If the document has never been saved, the default name is used (for example, Doc1.doc). If a document with the specified file name already exists, the document is overwritten without the user being prompted first.

fileFormat: Object

The format in which the document is saved. Can be any WdSaveFormat value. To save a document in another format, specify the appropriate value for the SaveFormat property.

lockComments: Object

true to lock the document for comments. The default is false.

password: Object

A password string for opening the document. (See Remarks below.)

addToRecentFiles: Object

true to add the document to the list of recently used files on the File menu. The default is true.

writePassword: Object

A password string for saving changes to the document. (See Remarks below.)

readOnlyRecommended: Object

true to have Microsoft Office Word suggest read-only status whenever the document is opened. The default is false.

embedTrueTypeFonts: Object

true to save TrueType fonts with the document. If omitted, the EmbedTrueTypeFonts argument assumes the value of the EmbedTrueTypeFonts property.

saveNativePictureFormat: Object

If graphics were imported from another platform (for example, Macintosh), true to save only the Windows version of the imported graphics.

saveFormsData: Object

true to save the data entered by a user in a form as a data record.

saveAsAOCELetter: Object

If the document has an attached mailer, true to save the document as an AOCE letter (the mailer is saved).

encoding: Object

MsoEncoding. The code page, or character set, to use for documents saved as encoded text files. The default is the system code page.

insertLineBreaks: Object

If the document is saved as a text file, true to insert line breaks at the end of each line of text.

allowSubstitutions: Object

If the document is saved as a text file, true allows Word to replace some symbols with text that looks similar. For example, displaying the copyright symbol as (c). The default is false.

lineEnding: Object

The way Word marks the line and paragraph breaks in documents saved as text files. Can be any T:Microsoft.Office.Interop.Word.WdLineEndingType value.

addBiDiMarks: Object

true adds control characters to the output file to preserve bi-directional layout of the text in the original document.

compatibilityMode: Object

One of the Microsoft.Office.Interop.Word.WdCompatibilityMode values that specifies the compatibility mode that Word 2013 and Word 2010 uses when opening the document.

Exceptions

MissingMemberException

This property is used in a Word 2007 project.

Examples

The following code example uses the <xref:Microsoft.Office.Tools.Word.DocumentBase.SaveAs%2A> method to save the document in RTF format using the new file name myfile.docx. To use this example, run it from the ThisDocument class in a document-level project.

private void DocumentSaveAs()
{
    object FileName = "myfile.docx";
    object FileFormat = Word.WdSaveFormat.wdFormatRTF;
    object LockComments = false;
    object AddToRecentFiles = true;
    object ReadOnlyRecommended = false;
    object EmbedTrueTypeFonts = false;
    object SaveNativePictureFormat = true;
    object SaveFormsData = true;
    object SaveAsAOCELetter = false;
    object Encoding = Office.MsoEncoding.msoEncodingUSASCII;
    object InsertLineBreaks = false;
    object AllowSubstitutions = false;
    object LineEnding = Word.WdLineEndingType.wdCRLF;
    object AddBiDiMarks = false;

    if (this.SaveFormat == (int)Word.WdSaveFormat.wdFormatDocument)
    {
        this.SaveAs(ref FileName, ref FileFormat, ref LockComments,
            ref missing, ref AddToRecentFiles, ref missing,
            ref ReadOnlyRecommended, ref EmbedTrueTypeFonts,
            ref SaveNativePictureFormat, ref SaveFormsData,
            ref SaveAsAOCELetter, ref Encoding, ref InsertLineBreaks,
            ref AllowSubstitutions, ref LineEnding, ref AddBiDiMarks);
    }
}

Private Sub DocumentSaveAs()

    Me.SaveAs(FileName:="myfile.docx", FileFormat:=Word.WdSaveFormat.wdFormatRTF, _
        LockComments:=False, AddToRecentFiles:=True, ReadOnlyRecommended:=False, _
        EmbedTrueTypeFonts:=False, SaveNativePictureFormat:=True, _
        SaveFormsData:=True, SaveAsAOCELetter:=False, _
        Encoding:=Office.MsoEncoding.msoEncodingUSASCII, _
        InsertLineBreaks:=False, AllowSubstitutions:=False, _
        LineEnding:=Word.WdLineEndingType.wdCRLF, _
        AddBiDiMarks:=False)
End Sub

Remarks

Avoid using hard-coded passwords in your applications. If a password is required in a procedure, request the password from the user, store it in a variable, and then use the variable in your code.

Note

This method appears in IntelliSense in Word 2007 projects that target the .NET Framework 4. However, this property cannot be used in Word 2007 projects.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Applies to

Share via