SubDocument.GetFlatOpcTemplateBytes(DocumentRange, FlatOpcTemplateDocumentExporterOptions) Method
Exports the range content in FlatOpcTemplate (Microsoft Word XML Template, .xml) format and returns a byte array with this content.
Namespace: DevExpress.XtraRichEdit.API.Native
Assembly: DevExpress.RichEdit.v24.2.Core.dll
NuGet Package: DevExpress.RichEdit.Core
Declaration
byte[] GetFlatOpcTemplateBytes(
DocumentRange range,
FlatOpcTemplateDocumentExporterOptions options
)Parameters
| Name | Type | Description |
|---|---|---|
| range | DocumentRange | The range to convert to FlatOpcTemplate format. |
| options | FlatOpcTemplateDocumentExporterOptions | An object that contains export settings. |
Returns
| Type | Description |
|---|---|
| Byte[] | The range content in FlatOpcTemplate format. |
Remarks
If you work with a selection range, make sure that the GetFlatOpcTemplate 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 FlatOpcMacroEnabled format:
using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
wordProcessor.LoadDocument("FirstLook.docx");
Document document = wordProcessor.Document;
FlatOpcTemplateDocumentExporterOptions exportOptions = wordProcessor.Options.Export.FlatOpcTemplate;
exportOptions.ExportedDocumentProperties = DocumentPropertyNames.None;
byte[] bytes = document.GetFlatOpcTemplateBytes(document.Range, exportOptions);
File.WriteAllBytes(@"D:\testdoc.xml", bytes);
}