RichEditDocumentServer.SaveDocument(Stream, DocumentFormat) Method

Saves the document to a stream, specifying the document’s format.

Namespace: DevExpress.XtraRichEdit

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

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

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(Stream, 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-automatic-document-conversion-on-web-server/CS/DocumentServerExample/Form1.cs#L59

server.SaveDocument(fsOut,destFormat);
fsIn.Close();

word-document-api-examples/CS/CodeExamples/ExportActions.cs#L99

{
    server.SaveDocument(htmlFileStream, DocumentFormat.Html);
}

RichEdit-How-to-insert-RTF-text-to-a-document/CS/RichInsertRTF/Controllers/HomeController.cs#L42

memoryStream = new MemoryStream();
server.SaveDocument(memoryStream, DocumentFormat.Rtf);
var model = new RichEditData

VB.NET

word-document-api-automatic-document-conversion-on-web-server/VB/DocumentServerExample/Form1.vb#L55

server.SaveDocument(fsOut, destFormat)
fsIn.Close()

word-document-api-examples/VB/CodeExamples/ExportActions.vb#L87

Using htmlFileStream As New FileStream(filePath, FileMode.Create)
    server.SaveDocument(htmlFileStream, DocumentFormat.Html)
End Using

RichEdit-How-to-insert-RTF-text-to-a-document/VB/RichInsertRTFVB/Controllers/HomeController.vb#L30

memoryStream = New MemoryStream()
server.SaveDocument(memoryStream, DocumentFormat.Rtf)
Dim model = New RichEditData With {

Implements

SaveDocument(Stream, DocumentFormat)