[]
        
(Showing Draft Content)

C1.C1Schedule.Appointment

Appointment Class

The Appointment object is a meeting, a one-time appointment, or a recurring appointment or meeting in the C1Schedule. The Appointment class includes properties that specify meeting details such as the location and time.

Inheritance
Appointment
Namespace: C1.C1Schedule
Assembly: C1.Win.C1Schedule.4.8.dll
Syntax
public class Appointment : BasePersistableObject, INotifyPropertyChanged, ISerializable

Constructors

Name Description
Appointment()

Initializes a new instance of the Appointment class.

Appointment(DateTime, DateTime)

Initializes a new instance of the Appointment class with the specified parameters.

Appointment(DateTime, DateTime, string)

Initializes a new instance of the Appointment class with the specified parameters.

Appointment(DateTime, TimeSpan)

Initializes a new instance of the Appointment class with the specified parameters.

Appointment(DateTime, TimeSpan, string)

Initializes a new instance of the Appointment class with the specified parameters.

Appointment(Guid)

Initializes a new instance of the Appointment class with the specified key.

Appointment(int)

Initializes a new instance of the Appointment class with the specified key.

Appointment(SerializationInfo, StreamingContext)

Special constructor for deserialization.

Properties

Name Description
Action

Gets an Action object for the Appointment object. Once this property is first requested, a new Action object is created and assigned to the Action property.

AllDayEvent

Gets or sets the bool value indicating if the current appointment is an All-day appointment.

AppointmentType

Gets or sets custom text value associated with this object.

AutoResolvedWinner

Gets the bool value determining if the item is a winner of an automatic conflict resolution.

Body

Gets or sets the string value representing the body of the Appointment object.

BusyStatus

Gets or sets the Status object indicating the busy status of the user for the appointment.

Categories

Gets the CategoryList object which holds the set of categories assigned to the appointment. Categories may be associated with an appointment to effectively group appointments. An appointment may be associated with multiple categories.

Conflicts

Gets the AppointmentList object representing the list of Appointment objects which are in conflict with this particular appointment.

CustomData

Gets or sets custom text associated with this object.

DragStartValue

For internal use only. The DragStartValue property can be used to keep DateTime value, where end-user started to drag appointment. It might be any time between app.Start and End values. If you set this field at the beginning of the drag and drop operation, later you can determine appointment.Start value as LastAcceptedStart.Add(newStart.Subtract(DragStartValue)), where newStart is DateTime value under the pointer. Appointment.EndEdit and CancelEdit methods reset this field to DateTime.MinValue.

Duration

Gets or sets the TimeSpan value indicating the duration of the appointment.

End

Gets or sets the DateTime value determining the end date and time of the appointment.

Importance

Gets or sets the ImportanceEnum value indicating the relative importance level for the appointment. Default value is Normal.

IsOneDay

Gets a bool value indicating either it is a one day appointment or shares some days.

IsRecurring

Gets the bool value indicating if the appointment is recurring.

Label

Gets or sets the Label object associated with this appointment.

LastAcceptedDuration

For internal use only. The last saved appointment duration (it doesn't changed between BeginEdit/EndEdit calls).

LastAcceptedStart

For internal use only. The last saved start value (it doesn't changed between BeginEdit/EndEdit calls).

Gets the ContactList object which holds the set of Contact objects for this appointment. An appointment may be associated with multiple contacts.

Location

Gets or sets the string value specifying where the appointment is going to be.

Owner

Gets or sets the Contact object which owns current Appointment object.

ParentCollection

Gets the reference to the parent AppointmentCollection object.

ParentRecurrence

Gets the Appointment object that defines the recurrence criteria for this Appointment object. If this appointment is a not member of a recurrence, or is itself a root appointment, null is returned.

Private

Gets or sets the bool value determining whether the calendar owner intends to keep the Appointment object private.

RecurrenceState

Gets the RecurrenceStateEnum value indicating the recurrence state of the appointment.

Reminder

Gets the Reminder object which is associated with the appointment. To associate an appointment with the reminder, set its ReminderSet property to true. Once this property is set to true, a new Reminder object is created and assigned to the Reminder property.

ReminderOverrideDefault

Gets or sets the bool value indicating if the associated Reminder object has non-default settings. True if the reminder overrides the default reminder behavior for the appointment. You must set the ReminderOverrideDefault property to validate the ReminderPlaySound and the ReminderSoundFile properties.

ReminderPlaySound

Gets or sets the bool value indicating if the reminder should play a sound when it occurs for this appointment or task. The ReminderPlaySound property must be set in order to validate the ReminderSoundFile property. This property is only valid if the ReminderOverrideDefault property is set to true.

ReminderSet

Gets or sets the bool value indicating whether a reminder is associated with the appointment. Once this property is set to true, a new Reminder object is created and assigned to the Reminder property.

ReminderSoundFile

Gets or sets the string value indicating the path and file name of the sound file to play when the reminder occurs for the appointment. This property is only valid if the ReminderOverrideDefault and ReminderPlaySound properties are set to true.

ReminderTimeBeforeStart

Gets or sets the TimeSpan value indicating the interval of time the reminder should occur prior to the start of the appointment.

Resources

Gets the ResourceList object which holds the set of Resource objects for this appointment. An appointment may be associated with multiple resources.

Saved

Gets the bool value indicating if the appointment has not been modified since the last save.

Sensitivity

Gets or sets the SensitivityEnum value indicating the sensitivity level of the appointment.

Start

Gets or sets the DateTime value determining the start date and time of the appointment.

Subject

Gets or sets the string value representing the subject of the Appointment object.

Tag

Gets or sets custom information associated with this object.

Methods

Name Description
BeginEdit()

Prevents the Appointment object from being updated until the EndEdit(bool) method is called.

CancelEdit()

Discards changes since the last BeginEdit() call.

ClearRecurrencePattern()

Removes the recurrence settings and restores the NotRecurring state for an appointment.

Copy()

Creates the copy of the Appointment object.

CopyFrom(Appointment, bool)

Copies properties from the specified Appointment object to this one.

CopyFrom(Appointment, bool, bool)

Copies properties from the specified Appointment object to this one.

Delete()

Deletes an appointment and removes it from the owning AppointmentCollection collection.

EndEdit(bool)

Unlocks the Appointment object after a call to the BeginEdit() method and causes an immediate update.

FromXml(XmlNode)

Reconstructs appointment from an XmlNode.

FromXml(XmlReader)

Reconstructs appointment from an XmlReader.

GetAppointmentProperties()

Returns XML encoding of appointment properties.

GetRecurrencePattern()

Returns the RecurrencePattern object that represents the recurrence attributes of an appointment. If there is no existing recurrence pattern, a new empty RecurrencePattern object is returned.

GetTimeTillEvent()

Returns a time term before the appointment start; a negative value means that appointment is expired.

IsGroupMember(BaseObject, string)

Returns True if the current Appointment object is a member of a group which is specified by the groupOwner and groupBy parameters; False otherwise.

OnPropertyChanged(string)

Overrides default behavior.

SaveAs(string, FileFormatEnum)

Saves the appointment to the specified path in the format of the specified file format.

SetAppointmentProperties(string)

Reconstructs appointment properties from the specified string.

ToXml(XmlWriter)

Creates an XML encoding of the appointment.