Class ExportOptions

A class that represents the export options of scheduler.

Inheritance

System.Object

ExportOptions

Namespace: Syncfusion.Blazor.Schedule

Assembly: Syncfusion.Blazor.dll

Syntax

public class ExportOptions : Object

Constructors

ExportOptions()

Declaration

public ExportOptions()

Properties

CustomData

Gets or sets the custom data collection that can be exported by passing it through the customData option.

Declaration

public object CustomData { get; set; }

Property Value

Type
System.Object

DateFormat

Gets or sets the date format for the appointment start and end dates in the exported file.

Declaration

public string DateFormat { get; set; }

Property Value

Type
System.String

ExportType

Gets or sets the export type, which allows you to specify the format of the exported Excel file. The supported file formats are .xlsx and .csv.

Declaration

public ExcelFormat ExportType { get; set; }

Property Value

Type
ExcelFormat

Fields

Gets or sets the custom or specific field collection of the event dataSource to be exported. This can be provided through the Fields option, which allows you to choose which fields to include in the exported file.

Declaration

public string[] Fields { get; set; }

Property Value

Type
System.String[]

FieldsInfo

Gets or sets the collection of field names and their associated header text for exporting to Excel.

Declaration

public List<ExportFieldInfo> FieldsInfo { get; set; }

Property Value

Type
System.Collections.Generic.List<ExportFieldInfo>

Remarks

If this list is empty, the scheduler exports the fields based on the Fields option. If both FieldsInfo and Fields are empty, the scheduler will export all fields.

FileName

Gets or sets the filename for the exported file.

Declaration

public string FileName { get; set; }

Property Value

Type
System.String

IncludeOccurrences

Gets or sets whether individual instances of recurring events should be exported as separate entries in the Excel file.

Declaration

public bool IncludeOccurrences { get; set; }

Property Value

Type
System.Boolean

Remarks

Setting this option to 'true' will include the individual instances in the exported file, while setting it to 'false' will exclude them.