iCalendarExporter Class

Represents an object that transforms Scheduler appointments into the event calendar components in iCalendar format.

Namespace: DevExpress.XtraScheduler.iCalendar

Assembly: DevExpress.XtraScheduler.v18.1.Core.dll

Declaration

C#

public class iCalendarExporter :
    AppointmentExporter

VB.NET

Public Class iCalendarExporter
    Inherits AppointmentExporter

Remarks

The main functionality of the iCalendarExporter class is provided by the AppointmentExporter.Export method.

You should specify the ISchedulerStorageBase object to supply appointments for export when creating an iCalendarExporter instance. To accomplish that, use the SchedulerControl.Storage property for WinForms Scheduler and the SchedulerStorage.InnerStorage property for WPF Scheduler.

To save custom appointment properties as non-standard properties in the iCalendar format , specify the iCalendarExporter.CustomPropertyIdentifier.

To change properties before they are written to output, subscribe to the iCalendarExporter.CalendarStructureCreated event. Its iCalendarStructureCreatedEventArgs.Calendars argument provides access to iCalendar structures.

You can cancel export for a particular calendar component by handling the AppointmentExporter.AppointmentExporting event.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the iCalendarExporter class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

icalendar-export-import-of-appointments-in-the-specified-interval-containing-custom-objects-e547/CS/iCalendarExportImport/Form1.cs#L91

iCalendarExporter exporter = new iCalendarExporter(schedulerStorage1, appointments);
exporter.CustomPropertyIdentifier = CustomPropertySignature;

how-to-customize-icalendar-format-import-and-export-operations-behavior-e3488/CS/Form1.cs#L21

private void btnExport_Click(object sender, EventArgs e) {
    iCalendarExporter exporter = new iCalendarExporter(schedulerStorage1);

how-to-provide-a-scheduler-with-the-icalendar-data-exchange-functionality-e3816/CS/WpfApplication1/MainWindow.xaml.cs#L67

    return;
iCalendarExporter exporter = new iCalendarExporter(schedulerControl1.Storage.InnerStorage);
exporter.ProductIdentifier = "-//Developer Express Inc.//DXScheduler iCalendarExchange Example//EN";

how-to-extend-text-properties-of-appointments-exported-to-icalendar-format-e2437/CS/Form1.cs#L85

    return;
iCalendarExporter exporter = new iCalendarExporter(schedulerStorage1);
exporter.AppointmentExporting +=

how-to-localize-winforms-scheduler-ui-using-the-localizer-class-descendant-t391865/CS/SchedulerLocalizerExample/OutlookAppointmentForm.cs#L370

aptsToExport.Add(Controller.EditedAppointmentCopy);
iCalendarExporter exporter = new iCalendarExporter(this.storage, aptsToExport);

VB.NET

icalendar-export-import-of-appointments-in-the-specified-interval-containing-custom-objects-e547/VB/iCalendarExportImport/Form1.vb#L93

Dim exporter As New iCalendarExporter(schedulerStorage1, appointments)
exporter.CustomPropertyIdentifier = CustomPropertySignature

how-to-customize-icalendar-format-import-and-export-operations-behavior-e3488/VB/Form1.vb#L23

Private Sub btnExport_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnExport.Click
    Dim exporter As New iCalendarExporter(schedulerStorage1)

how-to-provide-a-scheduler-with-the-icalendar-data-exchange-functionality-e3816/VB/WpfApplication1/MainWindow.xaml.vb#L72

End If
Dim exporter As New iCalendarExporter(schedulerControl1.Storage.InnerStorage)
exporter.ProductIdentifier = "-//Developer Express Inc.//DXScheduler iCalendarExchange Example//EN"

how-to-extend-text-properties-of-appointments-exported-to-icalendar-format-e2437/VB/Form1.vb#L90

End If
Dim exporter As New iCalendarExporter(schedulerStorage1)
AddHandler exporter.AppointmentExporting, AddressOf exporter_AppointmentExporting

how-to-localize-winforms-scheduler-ui-using-the-localizer-class-descendant-t391865/VB/SchedulerLocalizationExample_VB/OutlookAppointmentForm.vb#L409

aptsToExport.Add(Controller.EditedAppointmentCopy)
Dim exporter As New iCalendarExporter(Me.m_storage, aptsToExport)

Inheritance

Object

AppointmentExchanger

AppointmentExporter

iCalendarExporter