RichEditDocumentServer.SaveDocument(String, DocumentFormat) Method

Saves the control’s document to a file, specifying the document’s format.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

public virtual void SaveDocument(
    string fileName,
    DocumentFormat documentFormat
)

VB.NET

Public Overridable Sub SaveDocument(
    fileName As String,
    documentFormat As DocumentFormat
)

Parameters

Name	Type	Description
fileName	String	A string value specifying the path to a file into which to save the control’s document.
documentFormat	DocumentFormat	One of the DocumentFormat enumeration values.

Remarks

Use the RichEditControl.Options.Export property to set global export options, or handle the RichEditDocumentServer.BeforeExport event to specify options for an individual export action.

When the specified document format requires that a certain type of content should be saved as external objects, as is the case for HTML format, the proper use of the SaveDocument becomes more complex. You can specify whether images are embedded in HTML code, using the HtmlDocumentExporterOptions.EmbedImages property or provide a custom IUriProvider to construct src references for images.

Note

The SaveDocument method call does not automatically change the RichEditDocumentServer.Modified property value.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SaveDocument(String, DocumentFormat) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

word-document-api-examples/CS/CodeExamples/ProtectionActions.cs#L46

// Save and open the protected document.
wordProcessor.SaveDocument("ResultProtected.docx", DocumentFormat.OpenXml);
System.Diagnostics.Process.Start("ResultProtected.docx");

word-document-api-create-master-detail-report/CS/MasterDetailExample/MergeProcessor.cs#L62

    mainRichEdit.MailMerge(resultRichEdit.Document);
    resultRichEdit.SaveDocument("result.docx", DocumentFormat.OpenXml);
}

word-document-api-insert-inline-pictures/CS/InlinePictures/Program.cs#L45

    // Save the resulting document.
    wordProcessor.SaveDocument("InlinePictures.docx", DocumentFormat.OpenXml);
}

reporting-winforms-export-doc-odt/CS/WindowsFormsApplication1/Form1.cs#L68

    docServer.LoadDocument(ms, DocumentFormat.Rtf);
    docServer.SaveDocument(sfd.FileName, df);
}

word-document-api-open-and-save-encrypted-files/CS/word-processing-encryption/Program.cs#L53

server.SaveDocument(fileName, documentFormat);
Process.Start(fileName);

VB.NET

word-document-api-examples/VB/CodeExamples/ProtectionActions.vb#L39

' Save and open the protected document.
wordProcessor.SaveDocument("ResultProtected.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
System.Diagnostics.Process.Start("ResultProtected.docx")

word-document-api-create-master-detail-report/VB/MasterDetailExample/MergeProcessor.vb#L58

    mainRichEdit.MailMerge(resultRichEdit.Document)
    resultRichEdit.SaveDocument("result.docx", DocumentFormat.OpenXml)
End Sub

word-document-api-insert-inline-pictures/VB/InlinePictures/Program.vb#L38

    ' Save the resulting document.
    wordProcessor.SaveDocument("InlinePictures.docx", DocumentFormat.OpenXml)
End Using

reporting-winforms-export-doc-odt/VB/WindowsFormsApplication1/Form1.vb#L68

    docServer.LoadDocument(ms, DocumentFormat.Rtf)
    docServer.SaveDocument(sfd.FileName, df)
End Using

word-document-api-open-and-save-encrypted-files/VB/word-processing-encryption/Program.vb#L41

If IsValid = True Then
    server.SaveDocument(fileName, documentFormat)
    Call Process.Start(fileName)