Back to Devexpress

DiagramControl.ExportToImage(String, Nullable<Rect>, Nullable<Double>, Nullable<Double>) Method

wpf-devexpress-dot-xpf-dot-diagram-dot-diagramcontrol-dot-exporttoimage-x28-system-dot-string-system-dot-nullable-system-dot-windows-dot-rect-system-dot-nullable-system-dot-double-system-dot-nullable-system-dot-double-x29.md

latest3.4 KB
Original Source

DiagramControl.ExportToImage(String, Nullable<Rect>, Nullable<Double>, Nullable<Double>) 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 diagram to the specified file.

Namespace : DevExpress.Xpf.Diagram

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

NuGet Package : DevExpress.Wpf.Diagram

Declaration

csharp
public void ExportToImage(
    string path,
    Rect? exportBounds = null,
    double? dpi = null,
    double? scale = null
)
vb
Public Sub ExportToImage(
    path As String,
    exportBounds As Rect? = Nothing,
    dpi As Double? = Nothing,
    scale As Double? = Nothing
)

Parameters

NameTypeDescription
pathString

A string value that is the path to the file to which to save the diagram.

|

Optional Parameters

NameTypeDefaultDescription
exportBoundsNullable<Rect>null

A System.Windows.Rect object specifying the rectangle which encompasses the total background area when exporting the diagram.

| | dpi | Nullable<Double> | null |

A double value which represents the resolution (in dpi). The minimum supported value is 1.

| | scale | Nullable<Double> | null |

A double value that specifies the scale factor. Values from 0.1 to 30 are supported.

|

Remarks

The following file formats are supported: JPG, PNG, GIF, BMP. The desired file format is automatically detected based on the file extension.

If the dpi and scale parameters are not specified, the ExportDPI and ExportScale property values are used.

If the exportBounds parameter is not specified, the PrintExportMode and ExportMargin property values are used.

Use the ExportToSvg method to export the diagram to the SVG image format.

See Also

DiagramControl Class

DiagramControl Members

DevExpress.Xpf.Diagram Namespace