Back to Devexpress

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

windowsforms-devexpress-dot-xtradiagram-dot-diagramcontrol-dot-exporttoimage-x28-stream-diagramimageexportformat-nullable-rectanglef-nullable-single-nullable-single-x29.md

latest4.0 KB
Original Source

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

Exports the diagram to the specified stream in an image format.

Namespace : DevExpress.XtraDiagram

Assembly : DevExpress.XtraDiagram.v25.2.dll

NuGet Package : DevExpress.Win.Diagram

Declaration

csharp
public void ExportToImage(
    Stream stream,
    DiagramImageExportFormat exportFormat = DiagramImageExportFormat.PNG,
    RectangleF? exportBounds = null,
    float? dpi = null,
    float? scale = null
)
vb
Public Sub ExportToImage(
    stream As Stream,
    exportFormat As DiagramImageExportFormat = DiagramImageExportFormat.PNG,
    exportBounds As RectangleF? = Nothing,
    dpi As Single? = Nothing,
    scale As Single? = Nothing
)

Parameters

NameTypeDescription
streamStream

A System.IO.Stream object to which the created image file should be sent.

|

Optional Parameters

NameTypeDefaultDescription
exportFormatDiagramImageExportFormatPNG

A DevExpress.Diagram.Core.DiagramImageExportFormat enumeration value that specifies the image format.

| | exportBounds | Nullable<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

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

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

The exportFormat parameter only affects which format is selected by default. End-users can select any other available file format in the invoked dialog window.

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

See Also

DiagramControl Class

DiagramControl Members

DevExpress.XtraDiagram Namespace