Share via


DocumentBase.SaveFormat Property

Definition

Gets the file format of the document.

public:
 property int SaveFormat { int get(); };
public int SaveFormat { get; }
member this.SaveFormat : int
Public ReadOnly Property SaveFormat As Integer

Property Value

The file format of the document.

Examples

The following code example uses the <xref:Microsoft.Office.Tools.Word.DocumentBase.SaveAs%2A> method to save the document to the new file name myfile.docx in RTF format. 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

The value is a unique number that specifies an external file converter or a WdSaveFormat constant.

Use the value of this property for the FileFormat argument of the <xref:Microsoft.Office.Tools.Word.DocumentBase.SaveAs%2A> method to save a document in a file format for which there is not a corresponding WdSaveFormat constant.

Applies to