iCalendarImporter.CalendarStructureCreated Event

Fires when the calendar object conforming to the iCalendar specification is created.

Namespace: DevExpress.XtraScheduler.iCalendar

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

Declaration

C#

public event iCalendarStructureCreatedEventHandler CalendarStructureCreated

VB.NET

Public Event CalendarStructureCreated As iCalendarStructureCreatedEventHandler

Event Data

The CalendarStructureCreated event's data class is iCalendarStructureCreatedEventArgs. The following properties provide information specific to this event:

Property	Description
Calendars	Provides access to the calendar structures conforming to the iCalendar specification.

Remarks

Handle the CalendarStructureCreated event to obtain information on the iCalendar object, accessing its properties and attributes.

Example

The following example illustrates how the calendar structure constructed by the iCalendarImporter can be used to determine the time when the original appointment was created and the application used for .ics file generation.

The iCalendarImporter.CalendarStructureCreated event is handled and DevExpress.XtraScheduler.iCalendar.Components.iCalendarComponent object properties are inspected. The ProductIdentifier property specifies the identifier for the product that created the iCalendar object, the DevExpress.XtraScheduler.iCalendar.Components.VEvent.Created property specifies the date and time that the calendar information was created by the calendar user agent in the calendar store.

The information message is appended to the appointment’s subject, as illustrated in the following picture:

C#

using DevExpress.XtraScheduler;
using DevExpress.XtraScheduler.iCalendar;
using DevExpress.XtraScheduler.iCalendar.Components;
// ...
void importer_CalendarStructureCreated(object sender, iCalendarStructureCreatedEventArgs e) {
    iCalendarComponent cal = e.Calendars[0];
    string productId = cal.ProductIdentifier.Value;
    for (int i = 0; i < cal.Events.Count; i++)
    {
        VEvent ev = cal.Events[i];
        DateTime created = ev.Created.Value;
        ev.Description.Value += string.Format("[COMMENT: The event was originally created on" + 
        "{0} at {1} by an application with productId {2}]",
        created.ToShortDateString(), created.ToShortTimeString(), productId);
    }
}

VB.NET

Imports DevExpress.XtraScheduler
Imports DevExpress.XtraScheduler.iCalendar
Imports DevExpress.XtraScheduler.iCalendar.Components
' ...
Private Sub importer_CalendarStructureCreated(ByVal sender As Object,  _
    ByVal e As iCalendarStructureCreatedEventArgs)

    Dim cal As iCalendarComponent = e.Calendars(0)
    Dim productId As String = cal.ProductIdentifier.Value
    Dim i As Integer = 0
    Do While i < cal.Events.Count
        Dim ev As VEvent = cal.Events(i)
        Dim created As DateTime = ev.Created.Value
        ev.Description.Value += String.Format("[COMMENT: The event was originally created on"
        & "{0} at {1} by an application with productId {2}]",
        created.ToShortDateString(), created.ToShortTimeString(), productId)
        i += 1
    Loop
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CalendarStructureCreated event.

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#

drag-n-drop-and-ical-import-import-of-the-ical-file-being-dropped-on-xtrascheduler-e1463/CS/Drag_iCalFromFile/Form1.cs#L129

iCalendarImporter importer = new iCalendarImporter(schedulerStorage1);
importer.CalendarStructureCreated += new iCalendarStructureCreatedEventHandler(importer_CalendarStructureCreated);
importer.AppointmentImporting += new AppointmentImportingEventHandler(importer_AppointmentImporting);

VB.NET

drag-n-drop-and-ical-import-import-of-the-ical-file-being-dropped-on-xtrascheduler-e1463/VB/Drag_iCalFromFile/Form1.vb#L109

Dim importer As New iCalendarImporter(schedulerStorage1)
AddHandler importer.CalendarStructureCreated, AddressOf importer_CalendarStructureCreated
AddHandler importer.AppointmentImporting, AddressOf importer_AppointmentImporting