RichEditControl.SaveDocument(Stream, DocumentFormat) Method

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

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v24.2.dll

NuGet Package: DevExpress.Wpf.RichEdit

Declaration

C#

public virtual void SaveDocument(
    Stream stream,
    DocumentFormat documentFormat
)

VB.NET

Public Overridable Sub SaveDocument(
    stream As Stream,
    documentFormat As DocumentFormat
)

Parameters

Name	Type	Description
stream	Stream	The stream to which to output the document.
documentFormat	DocumentFormat	One of the DocumentFormat enumeration values.

Remarks

You can check for the Document.RequiredExportCapabilities to be sure that the chosen export format supports them.

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. Handle the RichEditControl.BeforeExport event to specify exporter options, such as the IExporterOptions.TargetUri and the HtmlDocumentExporterOptions.

Note

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