The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

IRichEditDocumentServer.SaveDocument(Stream, DocumentFormat) Method

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

Namespace: DevExpress.XtraRichEdit

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

Declaration

void SaveDocument(
    Stream stream,
    DocumentFormat documentFormat
)
Sub SaveDocument(
    stream As Stream,
    documentFormat As DocumentFormat
)
void SaveDocument(
    Stream stream,
    DocumentFormat documentFormat
)
Sub SaveDocument(
    stream As Stream,
    documentFormat As DocumentFormat
)
void SaveDocument(
    Stream stream,
    DocumentFormat documentFormat
)
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.

Parameters

Name Type Description
stream Stream

The stream to output the document to.

documentFormat DocumentFormat

One of the DocumentFormat enumeration values.

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

Note

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

See Also