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

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

Assembly : DevExpress.XtraDiagram.v25.2.dll

NuGet Package : DevExpress.Win.Diagram

Declaration

C#
VB.NET

csharp

public void ExportToImage(
    Stream stream,
    DiagramImageExportFormat exportFormat = DiagramImageExportFormat.PNG,
    RectangleF? exportBounds = null,
    float? dpi = null,
    float? scale = null
)

Public Sub ExportToImage(
    stream As Stream,
    exportFormat As DiagramImageExportFormat = DiagramImageExportFormat.PNG,
    exportBounds As RectangleF? = Nothing,
    dpi As Single? = Nothing,
    scale As Single? = Nothing
)

Parameters

Name	Type	Description
stream	Stream

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

Optional Parameters

Name	Type	Default	Description
exportFormat	DiagramImageExportFormat	PNG

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

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

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

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.