Document.SaveDocument(DocumentFormat) Method

Saves the document to a byte array in the specified file format.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

byte[] SaveDocument(
    DocumentFormat format
)

VB.NET

Function SaveDocument(
    format As DocumentFormat
) As Byte()

Parameters

Name	Type	Description
format	DocumentFormat	An enumeration member that specifies the output document format.

Returns

Type	Description
Byte[]	A byte array that contains data in the specified format.

Remarks

You can use this SaveDocument method overload to store a document in an external database.

C#

using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
// ...

Document document = richEditControl.Document;

// Save a document to a byte array to store it in a database.
byte[] docBytes = document.SaveDocument(DocumentFormat.OpenXml);

// ...

// Load the saved document from a byte array.
document.LoadDocument(docBytes, DocumentFormat.OpenXml);

VB.NET

Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
' ...

Dim document As Document = richEditControl.Document

' Save a document to a byte array to store it in a database.
Dim docBytes() As Byte = document.SaveDocument(DocumentFormat.OpenXml)

' ...

' Load the saved document from a byte array.
document.LoadDocument(docBytes, DocumentFormat.OpenXml)

Note

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SaveDocument(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#

snap-convert-snx-to-repx/CS/SnxToRepx/Converter/SnapReportConverter.cs#L26

    //Save a document to a byte array and call the GenerateReport method
    return GenerateReport(src.SaveDocument(SnapDocumentFormat.Snap));
}

VB.NET

snap-convert-snx-to-repx/VB/SnxToRepx/Converter/SnapReportConverter.vb#L26

    'Save a document to a byte array and call the GenerateReport method
    Return GenerateReport(src.SaveDocument(SnapDocumentFormat.Snap))
End Function