Back to Devexpress

HeatmapControl.ExportToDocx(String, DocxExportOptions) Method

wpf-devexpress-dot-xpf-dot-charts-dot-heatmap-dot-heatmapcontrol-dot-exporttodocx-x28-system-dot-string-devexpress-dot-xtraprinting-dot-docxexportoptions-x29.md

latest3.0 KB
Original Source

HeatmapControl.ExportToDocx(String, DocxExportOptions) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

Exports the Heatmap Control to a file in DOCX format with the specified export settings.

Namespace : DevExpress.Xpf.Charts.Heatmap

Assembly : DevExpress.Xpf.Charts.v25.2.dll

NuGet Package : DevExpress.Wpf.Charts

Declaration

csharp
public void ExportToDocx(
    string filePath,
    DocxExportOptions options
)
vb
Public Sub ExportToDocx(
    filePath As String,
    options As DocxExportOptions
)

Parameters

NameTypeDescription
filePathString

The file path that includes the file name and extension.

| | options | DocxExportOptions |

Export settings.

|

Remarks

The following example shows how to use the ExportToDocx method to export the Heatmap Control to a file with the specified export settings:

xaml
<dxh:HeatmapControl x:Name="heatmapControl">
    <dxh:HeatmapControl.PrintOptions>
        <dxh:HeatmapPrintOptions SizeMode="ProportionalZoom" />
    </dxh:HeatmapControl.PrintOptions>
</dxh:HeatmapControl>
<dx:SimpleButton Click="SimpleButton_Click"/>
csharp
using DevExpress.XtraPrinting;

    private void SimpleButton_Click(object sender, RoutedEventArgs e) {
        DocxExportOptions exportOptions = new DocxExportOptions();
        exportOptions.DocumentOptions.Title = "Heatmap";
        heatmapControl.ExportToDocx("D:/Temp/ExportedDocument.docx", exportOptions);
    }
vb
Imports DevExpress.XtraPrinting

    Private Sub SimpleButton_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
        Dim exportOptions As DocxExportOptions = New DocxExportOptions()
        exportOptions.DocumentOptions.Title = "Heatmap"
        heatmapControl.ExportToDocx("D:/Temp/ExportedDocument.docx", exportOptions)
    End Sub

See Also

ExportToDocx Overloads

HeatmapControl Class

HeatmapControl Members

DevExpress.Xpf.Charts.Heatmap Namespace