12,558,909 members (27,972 online)
Add your own
alternative version

383.6K views
2.6K downloads
125 bookmarked
Posted

# Adding iCalendar Support to Your Program - Part 1

, 14 Apr 2010 BSD
 Rate this:
Please Sign up or sign in to vote.
This article describes the steps to load and view iCalendars in your program by using the DDay.iCal library

## Introduction

This article describes how to load and view iCalendars by using the DDay.iCal library. I will cover more advanced topics, such as creating, editing, and serializing iCalendars in my next article.

In this article, I will walk you through creating a console application that will load and display upcoming events to the user. I've also included an example project that demonstrates how to add this kind of support to an ASP.NET web application.

## Background

Many programmers have worked with adding some kind of calendar support to an application - from displaying upcoming events on a web site, to allowing personalized calendars, with the ability to alter them.

So, thousands of programmers, all adding calendar support to their applications. So, what's the problem with that? The historical answer is that no (or very few) programmers followed any kind of standard to implement their calendars. So, if you needed to accomplish anything else with the calendar that your original application didn't support, you'd have to write it by hand.

Also, these ad-hoc calendars are only viewable from the application that wrote them. What if you want to allow for recurrences in your calendar, so an event can recur "every 2nd-to-last Sunday of the month?" What if you want to publish your calendar, so others can subscribe to it, and view it from the calendar program they prefer? What if you want to display and manipulate calendars from multiple sources, including sources that you may not have control over?

These are some of the problems the iCalendar standard solves for us. If you didn't already know -- iCalendar is a W3C recommendation known as RFC 5545. You can find it here.

## Using the Code

To begin, open Visual Studio and create a "Windows Console Application" project. Then, if you haven't already done so, download the latest binary version of DDay.iCal from SourceForge.net. Once you've done that, you simply need to add a reference to DDay.iCal.dll from your project (i.e. click "Add Reference" from the "Project" menu).

Then, add the following to the top of the Program.cs file:

using DDay.iCal;

You're now ready to load your first iCalendar! There are multiple ways you can load iCalendars, ranging from simply loading the file from your local filesystem, to loading from a WebDAV or CalDAV store, to loading from a database. The possibilities are endless; however, in this article, we'll focus on simply loading the file from your local filesystem. Add the following code to your Main() method (of course, replacing the path with the actual path to your iCalendar file).

// Load the calendar file
IICalendarCollection calendars = iCalendar.LoadFromFile(@"path\to\your\icalendar.ics");


Congratulations, you've loaded your iCalendar, and are ready to work with it! For now, let's display the events that occur today:

//
// Get all events that occur today.
//
IList&occurrence> occurrences = calendars.GetOccurrences
(DateTime.Today, DateTime.Today.AddDays(1));

Console.WriteLine("Today's Events:");

// Iterate through each occurrence and display information about it
foreach (Occurrence occurrence in occurrences)
{
DateTime occurrenceTime = occurrence.Period.StartTime.Local;
IRecurringComponent rc = occurrence.Source as IRecurringComponent;
if (rc != null)
Console.WriteLine(rc.Summary + ": " + occurrenceTime.ToShortTimeString());
}

That's it! To be clear, calendars.GetOccurrences(...) returns a list of Occurrence objects. Occurrence objects describe each occurrence, including the date/time the occurrence happens, and a reference to the original component that generated the occurrence. We cast the Source of the occurrence to an IRecurringComponent, and display its properties.

So, now we've displayed all the events that occur today. Let's display all of the upcoming events that will occur within the next 7 days:

//
// Get all occurrences for the next 7 days, starting tomorrow.
//
occurrences = calendars.GetOccurrences
(DateTime.Today.AddDays(1), DateTime.Today.AddDays(7));

Console.WriteLine(Environment.NewLine + "Upcoming Events:");

// Start with tomorrow
foreach (Occurrence occurrence in occurrences)
{
DateTime occurrenceTime = occurrence.Period.StartTime.Local;
IRecurringComponent rc = occurrence.Source as IRecurringComponent;
if (rc != null)
Console.WriteLine(rc.Summary + ": " + occurrenceTime.ToString());
}

As you can see, this code is nearly identical to "Today's Events", with a slight difference at calendars.GetOccurrences(...). We also display the full date/time of the recurrence this time.

Note: If you're only interested in certain kinds of components (i.e. Events, Todos, etc.), then you can get occurrences for only those events using the generic version of GetOccurrences (i.e. calendars.GetOccurrences<IEvent>(...)).

## Final Code

Here's the final result of Program.cs:

using System;
using System.Collections.Generic;
using System.Text;

// Required DDay.iCal namespace
using DDay.iCal;

namespace ConsoleApplication1
{
class Program
{
static void Main(string[] args)
{
// Load the calendar file
IICalendarCollection calendars = iCalendar.LoadFromFile(@"Business.ics");

//
// Get all events that occur today.
//
IList&occurrence> occurrences = calendars.GetOccurrences
(DateTime.Today, DateTime.Today.AddDays(1));

Console.WriteLine("Today's Events:");

// Iterate through each occurrence and display information about it
foreach (Occurrence occurrence in occurrences)
{
DateTime occurrenceTime = occurrence.Period.StartTime.Local;
IRecurringComponent rc = occurrence.Source as IRecurringComponent;
if (rc != null)
Console.WriteLine(rc.Summary + ": " +
occurrenceTime.ToShortTimeString());
}

//
// Get all occurrences for the next 7 days, starting tomorrow.
//
occurrences = calendars.GetOccurrences
(DateTime.Today.AddDays(1), DateTime.Today.AddDays(7));

Console.WriteLine(Environment.NewLine + "Upcoming Events:");

// Start with tomorrow
foreach (Occurrence occurrence in occurrences)
{
DateTime occurrenceTime = occurrence.Period.StartTime.Local;
IRecurringComponent rc = occurrence.Source as IRecurringComponent;
if (rc != null)
Console.WriteLine(rc.Summary + ": " + occurrenceTime.ToString());
}
}
}
}

## Points of Interest

For more information, visit the DDay.iCal homepage at ddaysoftware.com.

Many apologies that it's taken so long to update this article. I'll now be providing more frequent updates.

## History

• 04/14/2010 - Updated to version 1.0 Alpha
• 03/09/2007 - Posted

## License

This article, along with any associated source code and files, is licensed under The BSD License

## About the Author

 Web Developer United States
Doug has been a Software Engineer for 7 of the previous 9 years, and has 12 years of programming experience.

For the past 3 years, he has been developing custom applications in C# and Visual Basic.NET, with an emphasis on custom cross-Internet applications for IT management, real-time collaboration, and process management and reporting.

## Comments and Discussions

 First PrevNext
 Where are the docs? deostroll7-Feb-16 18:39 deostroll 7-Feb-16 18:39
 ICalendar Support for Visual Basic Member 1145177814-Feb-15 0:18 Member 11451778 14-Feb-15 0:18
 Re: ICalendar Support for Visual Basic Member 1039779223-Sep-15 5:25 Member 10397792 23-Sep-15 5:25
 Re: ICalendar Support for Visual Basic Member 1039779223-Sep-15 5:27 Member 10397792 23-Sep-15 5:27
 does this work with VS2012 and windows phone 8? kunwar_9124-Sep-13 8:39 kunwar_91 24-Sep-13 8:39
 Help for newbie with errors line 20 ptsmh10-Nov-11 9:49 ptsmh 10-Nov-11 9:49
 Sample or guidance on creating / reading VFREEBUSY rw_architect9-Sep-10 13:22 rw_architect 9-Sep-10 13:22
 Re: Sample or guidance on creating / reading VFREEBUSY Douglas Day10-Sep-10 4:30 Douglas Day 10-Sep-10 4:30
 Re: Sample or guidance on creating / reading VFREEBUSY rw_architect16-Oct-10 5:19 rw_architect 16-Oct-10 5:19
 Re: Sample or guidance on creating / reading VFREEBUSY Douglas Day26-Oct-10 10:33 Douglas Day 26-Oct-10 10:33
 VB.Net Example1 variable declaration errors... rw_architect5-Sep-10 17:07 rw_architect 5-Sep-10 17:07
 Re: VB.Net Example1 variable declaration errors... Douglas Day7-Sep-10 5:09 Douglas Day 7-Sep-10 5:09
 Randolph, I forgot to update the VB example for version 1.0. It's now updated in the trunk of Subversion, and will be included with the next release of DDay.iCal. Thanks for pointing that out Regards, -Doug
 Re: VB.Net Example1 variable declaration errors... Douglas Day7-Sep-10 5:18 Douglas Day 7-Sep-10 5:18
 Re: VB.Net Example1 variable declaration errors... rw_architect9-Sep-10 12:55 rw_architect 9-Sep-10 12:55
 Re: VB.Net Example1 variable declaration errors... Douglas Day9-Sep-10 13:00 Douglas Day 9-Sep-10 13:00
 OT [ Bad tutorial link from your home page for DDay.Update] Garth J Lancaster15-Apr-10 0:18 Garth J Lancaster 15-Apr-10 0:18
 Would be nice if article could be updated for version 0.80 manudurand14-Mar-10 1:52 manudurand 14-Mar-10 1:52
 Re: Would be nice if article could be updated for version 0.80 Douglas Day14-Mar-10 10:30 Douglas Day 14-Mar-10 10:30
 Re: Would be nice if article could be updated for version 0.80 manudurand14-Mar-10 16:21 manudurand 14-Mar-10 16:21
 Re: Would be nice if article could be updated for version 0.80 Douglas Day14-Mar-10 17:01 Douglas Day 14-Mar-10 17:01
 Re: Would be nice if article could be updated for version 0.80 manudurand14-Mar-10 19:50 manudurand 14-Mar-10 19:50
 Re: Would be nice if article could be updated for version 0.80 Douglas Day15-Mar-10 5:24 Douglas Day 15-Mar-10 5:24
 Re: Would be nice if article could be updated for version 0.80 Douglas Day15-Apr-10 6:06 Douglas Day 15-Apr-10 6:06
 great article jael3624-Nov-09 9:55 jael36 24-Nov-09 9:55
 Re: great article Douglas Day29-Dec-09 10:01 Douglas Day 29-Dec-09 10:01
 Last Visit: 31-Dec-99 18:00     Last Update: 27-Oct-16 6:57 Refresh 123 Next »

General    News    Suggestion    Question    Bug    Answer    Joke    Praise    Rant    Admin

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.161026.1 | Last Updated 14 Apr 2010
Article Copyright 2007 by Douglas Day
Everything else Copyright © CodeProject, 1999-2016
Layout: fixed | fluid