Class DiagramExportOptions

Options for ExportDiagram(DiagramExportOptions) and Print(DiagramExportOptions).

Inheritance

System.Object

DiagramExportOptions

Namespace: Syncfusion.Maui.Diagram

Assembly: Syncfusion.Maui.Diagram.dll

Syntax

public class DiagramExportOptions : Object

Remarks

Mirrors (a subset of) the EJ2 Diagram ExportOptions JSON shape, verified directly against the exportDiagram/print implementations in ej2.min.js. Deliberately excludes mode ("Download" vs. "Data"): the JavaScript wrapper in index.html always forces mode: "Data" so the exported content comes back through ExportDiagram(DiagramExportOptions)'s return value instead of triggering a browser-style file download inside the hosted WebView, which has no meaningful native-file behavior there. A plain, unmodified instance (or null) uses every EJ2 default: PNG, Content, 25-unit margins on every side.

Constructors

DiagramExportOptions()

Declaration

public DiagramExportOptions()

Properties

Bounds

Gets or sets an explicit region to export, in diagram coordinates. Defaults to null, letting EJ2 compute the bounds itself based on Region.

Declaration

public Nullable<Rect> Bounds { get; set; }

Property Value

Type
System.Nullable<Microsoft.Maui.Graphics.Rect>

FileName

Gets or sets the suggested file name (without extension) for the exported content. Defaults to null, which leaves EJ2's own default ("diagram") in effect. Only meaningful if a consumer chooses to save the returned data to disk themselves — this control never writes files.

Declaration

public string FileName { get; set; }

Property Value

Type
System.String

Format

Gets or sets the exported image format. Defaults to Png.

Declaration

public DiagramExportFormat Format { get; set; }

Property Value

Type
DiagramExportFormat

Margin

Gets or sets the margin, in diagram units, added around the exported content on every side. Defaults to null, which leaves EJ2's own default (25 units on every side) in effect.

Declaration

public Nullable<Thickness> Margin { get; set; }

Property Value

Type
System.Nullable<Microsoft.Maui.Thickness>

MultiplePage

Gets or sets whether to split the export across multiple pages. Defaults to false.

Declaration

public bool MultiplePage { get; set; }

Property Value

Type
System.Boolean

PageHeight

Gets or sets the page height, in diagram units. See the remarks on PageWidth.

Declaration

public Nullable<double> PageHeight { get; set; }

Property Value

Type
System.Nullable<System.Double>

PageOrientation

Gets or sets the page orientation. Defaults to null, which leaves EJ2's own default (Portrait) in effect.

Declaration

public Nullable<DiagramPageOrientation> PageOrientation { get; set; }

Property Value

Type
System.Nullable<DiagramPageOrientation>

PageWidth

Gets or sets the page width, in diagram units, used when MultiplePage is true or Region is PageSettings. Defaults to null, which falls back to the diagram's own page width.

Declaration

public Nullable<double> PageWidth { get; set; }

Property Value

Type
System.Nullable<System.Double>

Region

Gets or sets which area of the diagram to capture. Defaults to Content.

Declaration

public DiagramExportRegion Region { get; set; }

Property Value

Type
DiagramExportRegion