RichEditControl.SaveDocument(String, DocumentFormat) Method

Saves the control’s document to a file and specifies the document’s format.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

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 RichEditControl.BeforeExport event to specify options for an individual export action. Refer to the How to: Save a Document in the RichEdit Control example for more information.

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. Refer to the How to: Retain the Image URI in HTML Document article for the code example.

Note

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

Example

The following code saves a document to a file. The current RichEditControl instance is passed to the BarItem.ItemClick event handler using the BarItem.Tag property.

View Example

RichEditControlActions.cs

static void buttonCustomAction_ItemClick_SaveDocumentMethod(object sender, ItemClickEventArgs e) {
    RichEditControl richEdit = e.Item.Tag as RichEditControl;
    if(MessageBox.Show("Do you want to save this document to the default ('savedResults.docx') location?", 
        "Saving a document", MessageBoxButtons.YesNo) == DialogResult.Yes)

        richEdit.SaveDocument("savedResults.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
    else
        richEdit.SaveDocumentAs();
    System.Windows.Forms.MessageBox.Show("A document was saved sucsessfully");
}

RichEditControlActions.vb

Private Shared Sub buttonCustomAction_ItemClick_SaveDocumentMethod(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    Dim richEdit As RichEditControl = TryCast(e.Item.Tag, RichEditControl)
    If MessageBox.Show("Do you want to save this document to the default ('savedResults.docx') location?",
                       "Saving a document", MessageBoxButtons.YesNo) = DialogResult.Yes Then

        richEdit.SaveDocument("savedResults.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
    Else
        richEdit.SaveDocumentAs()
    End If
    System.Windows.Forms.MessageBox.Show("A document was saved sucsessfully")
End Sub

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#

how-to-save-a-document-in-the-richedit-control/CS/SaveDocument/Form1.cs#L38

{
    richEditControl1.SaveDocument("SavedDocument.rtf", DocumentFormat.Rtf);
    System.IO.FileInfo fi = new System.IO.FileInfo("SavedDocument.rtf");

winforms-richedit-document-encryption/CS/RichEditControl_Encryption/Form1.cs#L119

if (ext == ".docx")
    this.SaveDocument(myFileDialog.FileName, DocumentFormat.OpenXml);
else

winforms-richeditcontrol-common-api/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L122

    richEdit.SaveDocument("savedResults.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
else

word-processing-create-a-custom-format-exporter/CS/Form1.cs#L16

private void button1_Click(object sender, EventArgs e) {
    richEditControl1.SaveDocument("test.bbc", BBCodeDocumentFormat.Id);
}

how-to-retain-original-image-uri-in-html-document-e3189/CS/HTML_Export_ImageSourceExample/Form1.cs#L59

{
    richEditControl1.SaveDocument("test.html", DevExpress.XtraRichEdit.DocumentFormat.Html);
    System.Diagnostics.Process.Start("test.html");

VB.NET

how-to-save-a-document-in-the-richedit-control/VB/SaveDocument/Form1.vb#L31

Private Sub btnSaveToFile_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnSaveToFile.Click
    richEditControl1.SaveDocument("SavedDocument.rtf", DocumentFormat.Rtf)
    Dim fi As IO.FileInfo = New IO.FileInfo("SavedDocument.rtf")

winforms-richeditcontrol-common-api/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L127

    richEdit.SaveDocument("savedResults.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
Else

word-processing-create-a-custom-format-exporter/VB/Form1.vb#L18

Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles button1.Click
    richEditControl1.SaveDocument("test.bbc", BBCodeDocumentFormat.Id)
End Sub

how-to-retain-original-image-uri-in-html-document-e3189/VB/HTML_Export_ImageSourceExample/Form1.vb#L55

Private Sub btnSave_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnSave.Click
    richEditControl1.SaveDocument("test.html", DevExpress.XtraRichEdit.DocumentFormat.Html)
    System.Diagnostics.Process.Start("test.html")