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.v20.1.dll

Declaration

public virtual void SaveDocument(
    string fileName,
    DocumentFormat documentFormat
)
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.

Examples

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.

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");
}
See Also