Search
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

Current version of schedule file format.

 Public Properties

  Name Description

CanRedo

Gets a value indicating whether there is a command in the redo history which can be redone.

CanUndo

Gets a value indicating whether there is a command in the undo history which can be undone.

Contacts

Gets all contacts defined in the Schedule.

DisableItemTimeChecks

Gets or sets a value indicating whether to disable notification checks for item's start/end times.

DisableReminders

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

Items

Gets all scheduled items.

ItemTimeCheckInterval

Gets or sets the interval between item start/end time checks, expressed in seconds.

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.

UndoEnabled

Gets or sets a value indicating whether saving action records for later undo is enabled.

 Public Methods

  Name Description

CancelCompositeOperation

Stops recording undo/redo commands into a CompositeCommand and discards the records created so far.

Clear

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

CommitCompositeOperation

Stops recording undo/redo commands into a CompositeCommand and saves the composite in the history queue.

ExecuteCommand

Executes the specified command on this schedule.

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.

GetLargestFreePeriod

Returns the largest free period in the specified range.

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.

IsClientClassRegistered

Checks whether an item or resource type with the specified id is registered for JSON serialization.

LoadFrom

Loads schedule data from a file.

LoadFromJson

Loads the schedule from a JSON-formatted string.

LoadFromJsonObject

Loads the schedule from a JsonObject.

LoadFromString

Decodes schedule data from a string previously created by SaveToString.

LoadFromXml

Loads schedule data from an XML document.

Redo

Executes again an action saved in the command history.

RegisterItemClass

Overloaded.  

RegisterResourceClass

Overloaded.  

SaveTo

Saves the schedule to a file.

SaveToJson

Saves the schedule to a JSON-formatted string.

SaveToJsonObject

Saves the schedule to a JsonObject.

SaveToString

Encodes the schedule into a string.

SaveToXml

Saves the schedule to an XML document.

StartCompositeOperation

Starts recording undo/redo commands into a CompositeCommand.

Undo

Undoes an action saved in the command history.

UnregisterClass

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

 Protected Methods

  Name Description

OnActionRedone

Raises the ActionRedone event.

OnActionUndone

Raises the ActionUndone event.

OnDeserializeTag

Raises the DeserializeTag event.

OnExceptionCreated

Raises the ExceptionCreated event.

OnInstantiateItem

Raises the InstantiateItem event.

OnInstantiateResource

Raises the InstantiateResource event.

OnItemEndTimeChanged

Raises the ItemEndTimeChanged event.

OnItemEndTimeTriggered

Raises the ItemEndTimeTriggered event.

OnItemReminderTriggered

Raises the ItemReminderTriggered event.

OnItemResourceChanged

Raises the ItemResourceChanged event.

OnItemsEnded

Raises the ItemsEnded event.

OnItemsStarted

Raises the ItemsStarted event.

OnItemStartTimeChanged

Raises the ItemStartTimeChanged event.

OnItemVisualsChanged

Raises the ItemVisualsChanged event.

OnJsonDeserializeTag

Raises the DeserializeTag event.

OnJsonSerializeTag

Raises the JsonSerializeTag event.

OnRecurrenceReset

Raises the RecurrenceReset event.

OnSerializeTag

Raises the SerializeTag event.

OnTaskReminderTriggered

Raises the TaskReminderTriggered event.

 Public Events

  Name Description

ActionRedone

Raised when an action is redone.

ActionUndone

Raised when an action is undone.

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.

ItemResourceChanged

Raised when any of the resources associated with an item in the schedule has changed.

ItemsEnded

Raised when the current time (as returned by DateTime.Now) reaches the end of one or more items.

ItemsStarted

Raised when the current time (as returned by DateTime.Now) reaches the start time of one or more items.

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.

JsonDeserializeTag

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

JsonSerializeTag

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

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