XtraReport.ExportToDocx(String, DocxExportOptions) Method

Exports a report to the specified file DOCX format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.1.dll

Declaration

public void ExportToDocx(
    string path,
    DocxExportOptions options = null
)
Public Sub ExportToDocx(
    path As String,
    options As DocxExportOptions = Nothing
)

Parameters

Name Type Description
path String

The path to the exported DOCX file.

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.

IMPORTANT

This method overwrites files with the same name without confirmation.

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

See Also