XtraReport.ExportToDocx(Stream, DocxExportOptions) Method

Exports a report to the specified stream in DOCX format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.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 file in DOCX format with the specified DOCX export options.

If you do not specify export options, the method uses the current report export options. To access the report export options, use the XtraReport.ExportOptions.Docx notation.

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

Related GitHub Examples

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

reporting-mvc-print-export-report-without-preview/CS/T569785/Controllers/HomeController.cs#L78

case "docx":
    report.ExportToDocx(ms);
    break;

VB.NET

reporting-mvc-print-export-report-without-preview/VB/T569785/Controllers/HomeController.vb#L70

Case "docx"
    report.ExportToDocx(ms)
Case "xls"