XtraReport.ExportToDocx(Stream, DocxExportOptions) Method

Exports a report to the specified stream in DOCX format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.1.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Reporting.Core

Declaration

C#

public void ExportToDocx(
    Stream stream,
    DocxExportOptions options = null
)

VB.NET

Public Sub ExportToDocx(
    stream As Stream,
    options As DocxExportOptions = Nothing
)

Parameters

Name	Type	Description
stream	Stream	A Stream for output data.

Optional Parameters

Name	Type	Default	Description
options	DocxExportOptions	null	The DOCX export options. You can omit this parameter to use the current report export options.

Remarks

Note

Once the document export has started, it runs to completion and you cannot interrupt or cancel it.

This method exports a report to a DOCX file with the specified DOCX export options.

If the export options are not specified, the current report export options are used. To access the report export options, use the the report’s XtraReport.ExportOptions property. The property contains the ExportOptions object whose ExportOptions.Docx property provides access to the DocxExportOptions object that contains the DOCX export options.

Use the ExportToDocxAsync(Stream, DocxExportOptions, CancellationToken) method instead of ExportToDocx to export a report asynchronously in a separate task.