Skip to main content
A newer version of this page is available. .

Appointment Members

An interface that defines an appointment in the Scheduler.

Properties

Name Description
AllDay Gets or sets whether the current appointment lasts the entire day (or several days).
CustomFields Gets the collection of custom fields bound to the persistent object. Inherited from IPersistentObject.
Description Gets or sets the text for the appointment’s description.
Duration Gets or sets the duration of the appointment.
End Gets or sets the end date and time of the appointment.
HasExceptions Gets whether changed or deleted occurrences have been created for the current pattern appointment.
HasReminder Gets or sets a value that indicates whether one or more reminders are associated with the appointment.
Id Gets the object’s identifier. Inherited from IPersistentObject.
IsBase Gets whether the appointment is base (of the Normal or Pattern type).
IsDisposed Gets a value indicating whether a persistent object has been disposed of. Inherited from IPersistentObject.
IsException Gets whether the appointment is an exception (of the ChangedOccurrence or DeletedOccurrence type).
IsOccurrence Gets whether the appointment is an occurrence (of the Occurrence, ChangedOccurrence or DeletedOccurrence type).
IsRecurring Gets whether the appointment is recurring.
IsUpdateLocked Gets whether the persistent object is locked while it is being updated. Inherited from IPersistentObject.
LabelId Obsolete. Gets or sets the integer identifier of the label object associated with the appointment. Obsolete. Use the Appointment.LabelKey property instead.
LabelKey Gets or sets the identifier of the label object associated with the appointment.
Location Gets or sets the text that specifies a place where the appointment is scheduled.
LongerThanADay Gets whether the appointment’s duration is equal to or greater than one day.
OriginalOccurrenceEnd Gets the Appointment.End value for the appointment in a recurrence series that conforms to the recurrence rule.
OriginalOccurrenceStart Gets the Appointment.Start value for the appointment in a recurrence series that conforms to the recurrence rule.
PercentComplete Gets or sets the value that describes the completion status of a task.
RecurrenceIndex Gets the index in the recurrence series.
RecurrenceInfo Gets information that specifies recurrence rules.
RecurrencePattern Gets the pattern appointment for the current appointment.
Reminder Gets a reminder associated with the current appointment (the first reminder in the collection, if there are several reminders).
Reminders Gets a collection of reminders associated with the current appointment.
ResourceId Gets or sets the unique identifier of the resource associated with the current appointment, or the ID of the first resource if resource sharing is enabled.
ResourceIds Gets a collection of identifiers of all resources associated with the current appointment.
RowHandle Gets or sets a value that identifies the data row bound to the persistent object. Inherited from IPersistentObject.
SameDay Gets whether the appointment’s start and end times are on the same day.
Start Gets or sets the start date and time of the appointment.
StatusId Obsolete. Gets or sets the integer identifier of the status object associated with the appointment. Obsolete. Use the Appointment.StatusKey property instead.
StatusKey Gets or sets the unique identifier of the status object associated with the appointment.
Subject Gets or sets the appointment’s subject text.
TimeZoneId Gets or sets a time zone identifier for an appointment.
Type Gets the type of an appointment.

Methods

Name Description
Assign(Appointment) Copies all settings from the object passed as the parameter to the current object.
Assign(IPersistentObject) Copies all properties of the object passed as the parameter to the current object. Inherited from IPersistentObject.
Copy() Creates a copy of the current Appointment object.
CreateException(AppointmentType, Int32) Creates an exceptional appointment within a chain of recurring appointments.
CreateNewReminder() Creates a new Reminder for this appointment.
Delete() Deletes the persistent object from the storage or collection. Inherited from IPersistentObject.
DeleteExceptions() Removes changed and deleted occurrences for the current pattern appointment.
Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Inherited from IDisposable.
FindException(Int32) Returns an appointment that is an exception in the recurrence series at the specified index.
GetExceptions() Returns a collection of the changed and deleted occurrences for the current pattern appointment.
GetOccurrence(Int32) Gets an occurrence at the specified position within a series of recurring appointments.
GetRow(ISchedulerStorageBase) Provides access to the data record for the persistent object. Inherited from IPersistentObject.
GetSourceObject(ISchedulerStorageBase) Returns the data object that is bound to the current persistent object. Inherited from IPersistentObject.
GetValue(ISchedulerStorageBase, String) Obtains the value of the data field in the record bound to the current PersistentObject, supplied by the specified storage object. Inherited from IPersistentObject.
RestoreOccurrence() Replaces an exceptional appointment with the regular occurrence in the recurring series.
SetId(Object) Sets the identifier property of an object to the specified value. Inherited from IIdProvider.
SetValue(ISchedulerStorageBase, String, Object) Performs a transaction to change the value of the field in the data record bound to the persistent object. Inherited from IPersistentObject.
See Also