Back to Devexpress

DiagramControl.ExportToImage(String, Nullable<RectangleF>, Nullable<Single>, Nullable<Single>) Method

windowsforms-devexpress-dot-xtradiagram-dot-diagramcontrol-dot-exporttoimage-x28-system-dot-string-system-dot-nullable-system-dot-drawing-dot-rectanglef-system-dot-nullable-system-dot-single-system-dot-nullable-system-dot-single-x29.md

latest3.7 KB
Original Source

DiagramControl.ExportToImage(String, Nullable<RectangleF>, Nullable<Single>, Nullable<Single>) 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 in an image format.

Namespace : DevExpress.XtraDiagram

Assembly : DevExpress.XtraDiagram.v25.2.dll

NuGet Package : DevExpress.Win.Diagram

Declaration

csharp
public void ExportToImage(
    string path,
    RectangleF? exportBounds = null,
    float? dpi = null,
    float? scale = null
)
vb
Public Sub ExportToImage(
    path As String,
    exportBounds As RectangleF? = Nothing,
    dpi As Single? = Nothing,
    scale As Single? = Nothing
)

Parameters

NameTypeDescription
pathString

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

|

Optional Parameters

NameTypeDefaultDescription
exportBoundsNullable<RectangleF>null

A System.Drawing.RectangleF object specifying the rectangle which encompasses the total background area when exporting the diagram.

| | dpi | Nullable<Single> | null |

A System.Single value which represents the resolution (in dpi). The minimum supported value is 1. The default is 96.

| | scale | Nullable<Single> | null |

A System.Single value that specifies the scale factor. Values from 0.1 to 30 are supported. The default is 1.

|

Remarks

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

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

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

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

See Also

DiagramControl Class

DiagramControl Members

DevExpress.XtraDiagram Namespace