Class ChartExportingEventArgs

Provides information about the chart export event when Exporting is triggered.

Inheritance

object

ChartExportingEventArgs

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.ChartWizard

Assembly: Syncfusion.Blazor.dll

Syntax

public class ChartExportingEventArgs

Remarks

This class contains properties that allow you to modify or cancel the export operation, and control how the exported chart content is handled.

Constructors

ChartExportingEventArgs()

Declaration

public ChartExportingEventArgs()

Properties

Cancel

Gets or sets a value indicating whether to cancel the exporting process.

Declaration

public bool Cancel { get; set; }

Property Value

Type	Description
bool	A bool value. true to cancel the export; otherwise, false. The default value is false.

Remarks

Setting this property to true within the Exporting event handler will prevent the chart from being exported. This is useful for implementing custom validation or user confirmations before allowing the export to proceed.

FileName

Gets or sets the name for the exported file.

Declaration

public string FileName { get; set; }

Property Value

Type	Description
string	A string representing the name of the file to be exported. The default value is `string.Empty`.

Remarks

This property allows you to customize the file name before the export operation is completed. Its initial value is derived from the FileName property, if provided. The file extension will typically be determined by the export type (e.g., .png, .pdf, .xlsx).

Height

Gets or sets the height of the exported chart in pixels.

Declaration

public double Height { get; set; }

Property Value

Type	Description
double	A double value representing the height in pixels. If set to `double.NaN`, the chart's default rendered height will be used. The default value is `double.NaN`.

Remarks

This property specifies the custom height for the chart when it is exported. Its initial value is derived from the Height property, if provided. Modifying this value within the Exporting event handler will override the chart's dimensions for the export output. Note that this property is not applicable for XLSX and CSV export formats, as these formats are data-centric rather than visually-rendered.

Orientation

Gets or sets the page orientation for the PDF document when exporting the chart.

Declaration

public PageOrientation Orientation { get; set; }

Property Value

Type	Description
PageOrientation	A PageOrientation enum value. The default value is Portrait.

Remarks

This property is applicable only when the chart is exported to a PDF format. Its initial value is derived from the Orientation property, if provided This property controls how the chart is laid out on the PDF page. The available orientations are:

Portrait - Specifies that the PDF page is oriented vertically.
Landscape - Specifies that the PDF page is oriented horizontally.

Width

Gets or sets the width of the exported chart in pixels.

Declaration

public double Width { get; set; }

Property Value

Type	Description
double	A double value representing the width in pixels. If set to `double.NaN`, the chart's default rendered width will be used. The default value is `double.NaN`.

Remarks

This property specifies the custom width for the chart when it is exported. Its initial value is derived from the Width property, if provided. Modifying this value within the Exporting event handler will override the chart's dimensions for the export output. Note that this property is not applicable for XLSX and CSV export formats, as these formats are data-centric rather than visually rendered.