PocketPlanner Programmer's Guide

Schedule Members

Constructors Fields Properties Methods Events

Represents a timetable of scheduled events. In the model-view architecture, Schedule instances are the documents whose data is displayed by Calendar instances - the views.

The following tables list the members exposed by the Schedule type.

 Public Constructors

  Name Description

Schedule

Initializes a new instance of the Schedule class.

 Public Fields

  Name Description

CurrentVersion

The current version of the schedule file format.

 Public Properties

  Name Description

Contacts

Gets all contacts defined in the Schedule.

DisableReminders

Gets or sets a value indicating whether to completely disable reminders in the whole schedule.

Items

Gets all scheduled items.

Locations

Gets all locations defined in the Schedule.

RemindersCheckInterval

Gets or sets the interval between reminder checks, expressed in seconds.

Resources

Gets all resources defined in the Schedule.

Tasks

Gets all tasks defined in this Schedule.

 Public Methods

  Name Description

Clear

Clears all items, tasks, locations, contacts and resources contained in this schedule.

Dispose

Disposes any resources used by this Schedule object.

GetAllItems

Overloaded. Retrieves a collection of all events, including recurrent item instances, scheduled to occur in the specified time interval.

GetFreePeriod

Overloaded. Returns the next period with the specified duration after the specified date, which is not occupied by items.

GetItemsToRemindOf

Overloaded. Retrieves a collection of all items that must be reminded of.

GetTasksToRemindOf

Overloaded. Retrieves a collection of all tasks that must be reminded of.

IsClassRegistered

Overloaded. Checks whether a specified class identifier or type is registered for serialization.

LoadFrom

Overloaded. Loads schedule data from a file, a binary stream or an XML document.

LoadFromString

 

LoadFromXml

Loads schedule data from an XML document.

RegisterItemClass

Registers a schedule item class for serialization support.

RegisterResourceClass

Registers a resource class for serialization support.

SaveTo

Overloaded. Saves the schedule to a file, a binary stream or an XML document.

SaveToString

 

SaveToXml

Saves the schedule to an XML document.

UnregisterClass

Overloaded. Unregisters the item or resource with the specified class identifier or type from the system.

 Protected Methods

 Public Events

  Name Description

Changed

Raised when items are added or removed from the schedule or when the schedule is loaded.

DeserializeTag

Raised during XML deserialization to enable users to perform custom deserialization of the tag values of items and resources.

ExceptionCreated

Raised when a recurrence exception item is created.

InstantiateItem

Raised when deserializing a custom item whose type has not been registered.

InstantiateResource

Raised when deserializing a custom resource whose type has not been registered.

ItemEndTimeChanged

Raised when the EndTime property of an item in this Schedule has changed. The ItemTimeEventArgs.Time property provides the previous EndTime value of the item.

ItemEndTimeTriggered

Raised when the reminder for an item is triggered, but taking into consideration the item's end time for the purpose.

ItemReminderTriggered

Raised when the reminder for an item is triggered.

ItemStartTimeChanged

Raised when the StartTime property of an item in this Schedule has changed. The ItemTimeEventArgs.Time property provides the previous StartTime value of the item.

ItemVisualsChanged

Raised when the appearance of an item in the schedule has changed.

RecurrenceReset

Raised when the recurrence pattern associated with an item has been reset, causing all associated exception items to be lost.

SerializeTag

Raised during XML serialization to enable users to perform custom serialization of the tag values of items and resources.

TaskReminderTriggered

Raised when the reminder for a task is triggered.

 See Also