SubDocument.GetFlatOpcBytes(DocumentRange, FlatOpcDocumentExporterOptions) Method

Exports the range content in FlatOpc (Microsoft Word XML Document, .xml) format and returns a byte array with this content.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

byte[] GetFlatOpcBytes(
    DocumentRange range,
    FlatOpcDocumentExporterOptions options
)

VB.NET

Function GetFlatOpcBytes(
    range As DocumentRange,
    options As FlatOpcDocumentExporterOptions
) As Byte()

Parameters

Name	Type	Description
range	DocumentRange	The range to convert to FlatOpc format.
options	FlatOpcDocumentExporterOptions	An object that contains export options.

Returns

Type	Description
Byte[]	The range content in FlatOpc format.

Remarks

If you work with a selection range, make sure that the GetFlatOpcBytes method is enclosed with the DocumentRange.BeginUpdateDocument - DocumentRange.EndUpdateDocument method pair. Otherwise, an incorrect document model might be selected, and the “Error: specified document position or range belongs to other document or subdocument” exception is thrown.

To retrieve section settings, make sure that the range contains the last section’s paragraph. Otherwise, the section settings are reset to default.

The code sample below retrieves the range content in FlatOpc format:

C#

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
    wordProcessor.LoadDocument("FirstLook.docx");
    Document document = wordProcessor.Document;
    FlatOpcDocumentExporterOptions exportOptions = 
    wordProcessor.Options.Export.FlatOpc;
    exportOptions.ExportedDocumentProperties = 
    DocumentPropertyNames.None;
    byte[] bytes = document.GetFlatOpcBytes(document.Range, exportOptions);
    File.WriteAllBytes(@"D:\testdoc.xml", bytes);
}

VB.NET

Using wordProcessor As New RichEditDocumentServer()
  wordProcessor.LoadDocument("FirstLook.docx")
  Dim document As Document = wordProcessor.Document
  Dim exportOptions As FlatOpcDocumentExporterOptions = 
  wordProcessor.Options.Export.FlatOpc
  exportOptions.ExportedDocumentProperties = 
  DocumentPropertyNames.None
  Dim bytes() As Byte = document.GetFlatOpcBytes(document.Range, exportOptions)
  File.WriteAllBytes("D:\testdoc.xml", bytes)
End Using