Scheduler for WinForms | ComponentOne
C1.ScheduleCore Assembly / C1.Schedule Namespace / Appointment Class
Properties Methods


In This Topic
    Appointment Class Members
    In This Topic

    The following tables list the members exposed by Appointment.

    Public Constructors
     NameDescription
    Public ConstructorAppointment ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyActionGets 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.  
    Public PropertyAllDayEventGets or sets the System.Boolean value indicating if the current appointment is an All-day appointment.  
    Public PropertyAppointmentTypeGets or sets custom text value associated with this object.  
    Public PropertyAutoResolvedWinnerGets the System.Boolean value determining if the item is a winner of an automatic conflict resolution.  
    Public PropertyBodyGets or sets the System.String value representing the body of the Appointment object.  
    Public PropertyBusyStatusGets or sets the Status object indicating the busy status of the user for the appointment.  
    Public PropertyCategoriesGets or sets 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.  
    Public PropertyConflictsGets the AppointmentList object representing the list of Appointment objects which are in conflict with this particular appointment.  
    Public PropertyCustomDataGets or sets custom text associated with this object.  
    Public PropertyDragStartValueFor 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.  
    Public PropertyDurationGets or sets the System.TimeSpan value indicating the duration of the appointment.  
    Public PropertyEndGets or sets the System.DateTime value determining the end date and time of the appointment.  
    Public PropertyEndDateReturns the appointment end date.  
    Public PropertyIdGets the unique id used for serialization purposes. (Inherited from C1.Schedule.BasePersistableObject)
    Public PropertyImportanceGets or sets the ImportanceEnum value indicating the relative importance level for the appointment. Default value is ImportanceEnum.Normal.  
    Public PropertyInCollectionReturns the System.Boolean values specifying whether the current appointment has been added to the parent AppointmentCollection.  
    Public PropertyIsAllDayOrMultiDayReturns the System.Boolean value indicating whether the duration of the appointment is greater than or equal to one day.  
    Public PropertyIsEditIndicates whether the object is in edit mode, which is started using the BasePersistableObject.BeginEdit method. (Inherited from C1.Schedule.BasePersistableObject)
    Public PropertyIsOneDayGets a System.Boolean value indicating either it is a one day appointment or shares some days.  
    Public PropertyIsRecurringGets the System.Boolean value indicating if the appointment is recurring.  
    Public PropertyKeyGets an array of objects representing the key of the BasePersistableObject. (Inherited from C1.Schedule.BasePersistableObject)
    Public PropertyLabelGets or sets the Label object associated with this appointment.  
    Public PropertyLastAcceptedDurationFor internal use only. The last saved appointment duration (it doesn't changed between BeginEdit/EndEdit calls).  
    Public PropertyLastAcceptedStartFor internal use only. The last saved start value (it doesn't changed between BeginEdit/EndEdit calls).  
    Public PropertyLinksGets or sets the ContactList object which holds the set of Contact objects for this appointment. An appointment may be associated with multiple contacts.  
    Public PropertyLocationGets or sets the System.String value specifying where the appointment is going to be.  
    Public PropertyOwnerGets or sets the Contact object which owns current Appointment object.  
    Public PropertyParentCollectionGets or sets the reference to the parent AppointmentCollection object.  
    Public PropertyParentRecurrenceGets 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.  
    Public PropertyPrivateGets or sets the System.Boolean value determining whether the calendar owner intends to keep the Appointment object private.  
    Public PropertyRecurrenceStateGets the RecurrenceStateEnum value indicating the recurrence state of the appointment.  
    Public PropertyReminderGets 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.  
    Public PropertyReminderOverrideDefaultGets or sets the System.Boolean 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.  
    Public PropertyReminderPlaySoundGets or sets the System.Boolean 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.  
    Public PropertyReminderSetGets or sets the System.Boolean 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.  
    Public PropertyReminderSoundFileGets or sets the System.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.  
    Public PropertyReminderTimeBeforeStartGets or sets the System.TimeSpan value indicating the interval of time the reminder should occur prior to the start of the appointment.  
    Public PropertyResourcesGets or sets the ResourceList object which holds the set of Resource objects for this appointment. An appointment may be associated with multiple resources.  
    Public PropertySavedGets the System.Boolean value indicating if the appointment has not been modified since the last save.  
    Public PropertySensitivityGets or sets the SensitivityEnum value indicating the sensitivity level of the appointment.  
    Public PropertyStartGets or sets the System.DateTime value determining the start date and time of the appointment.  
    Public PropertySubjectGets or sets the System.String value representing the subject of the Appointment object.  
    Public PropertyTagGets or sets custom information associated with this object.  
    Top
    Public Methods
     NameDescription
    Public MethodBeginEditOverridden. Prevents the Appointment object from being updated until the EndEdit(Boolean) method is called.  
    Public MethodCancelEditOverridden. Discards changes since the last BeginEdit call.  
    Public MethodClearRecurrencePatternRemoves the recurrence settings and restores the RecurrenceStateEnum.NotRecurring state for an appointment.  
    Public MethodCompareToPerforms a comparison with another Appointment object based on the start time and subject.  
    Public MethodCopyCreates the copy of the Appointment object.  
    Public MethodCopyFromOverloaded. Copies properties from the specified Appointment object to this one.  
    Public MethodCopyPatternFromCopies RecurrencePattern from the specified Appointment  
    Public MethodDeleteDeletes an appointment and removes it from the owning AppointmentCollection collection.  
    Public MethodEndEditOverloaded. Overridden. Unlocks the Appointment object after a call to the BeginEdit method and causes an immediate update.  
    Public MethodFromXmlOverloaded. Overridden. Reconstructs appointment from an System.Xml.XmlNode.  
    Public MethodGetAppointmentPropertiesReturns XML encoding of appointment properties.  
    Public MethodGetFileNameCreate string which can be used as a file name from appointment subject.  
    Public MethodGetRecurrencePatternReturns 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.  
    Public MethodGetTimeTillEventReturns a time term before the appointment start; a negative value means that appointment is expired.  
    Public MethodInvalidatePropertiesInvalidates appointment properties.  
    Public MethodIsGroupMemberReturns True if the current Appointment object is a member of a group which is specified by the groupOwner and groupBy parameters; False otherwise.  
    Public MethodSatisfyAllDayEventConditionsReturns the System.Boolean value indicating whether according to the appointment times and duration the appointment is an all-day event.  
    Public MethodSaveAsSaves the appointment to the specified path in the format of the specified file format.  
    Public MethodSetAppointmentPropertiesReconstructs appointment properties from the specified string.  
    Public MethodSetDirtySpecifies that the current appointment has been changed and should invalidate properties.  
    Public MethodSetOwnerSets a new group owner for the current appointment  
    Public MethodToXmlOverloaded. Overridden. Creates an XML encoding of the appointment.  
    Top
    Protected Methods
     NameDescription
    Protected MethodGetObjectDataA method called when serializing. (Inherited from C1.Schedule.BasePersistableObject)
    Protected MethodOnPropertyChangedOverridden. Overrides default behavior.  
    Top
    See Also

    Reference

    Appointment Class
    C1.Schedule Namespace