AppointmentFormController Members
Provides all the settings which are required to edit a particular appointment in a custom Edit Appointment form.Constructors
| Name | Description |
|---|---|
| AppointmentFormController(SchedulerControl, Appointment) | Initializes a new instance of the AppointmentFormController class with the specified settings. |
Properties
| Name | Description |
|---|---|
| AllDay | Gets or sets a value indicating if the appointment currently being edited in the form is an All-day appointment. Inherited from AppointmentFormControllerBase. |
| AppointmentResource | Gets or sets the resource associated with the current appointment, or the first resource if resource sharing is enabled. |
| AppointmentResourceIds | Gets or sets the identifiers of all resources associated with the appointment currently being edited in the form. |
| AppointmentResources | Gets or sets the collection of resources stored in the data storage of the SchedulerControl, which contains the appointment currently being edited in the form. |
| AppointmentType | Gets the type of appointment. Inherited from AppointmentModificationControllerBase. |
| CanDeleteAppointment | Gets a value that indicates if the appointment currently being edited in the form can be deleted. Inherited from AppointmentFormControllerBase. |
| CanEditResource | Gets a value that indicates whether the resource can be changed for the appointment which is currently being edited in the form. Inherited from AppointmentFormControllerBase. |
| Caption | Gets the caption used in appointment editing form. Inherited from AppointmentFormControllerBase. |
| Control | Gets the Scheduler Control containing the appointment currently being edited in the form. |
| Description | Gets or sets the text that will be displayed as the description of the appointment currently being edited in the form. Inherited from AppointmentFormControllerBase. |
| DisplayEnd | Gets or sets the value to display as the appointment’s end time within the editing form. Inherited from AppointmentFormControllerBase. |
| DisplayEndDate | Gets or sets the appointment‘s end date to be displayed in the editing form. |
| DisplayEndTime | Gets or sets the appointment‘s end time to be displayed in the editing form. |
| DisplayStart | Gets or sets the value to display as the appointment’s start time within the editing form. Inherited from AppointmentFormControllerBase. |
| DisplayStartDate | Gets or sets the appointment‘s start date to be displayed in the editing form. |
| DisplayStartTime | Gets or sets the appointment‘s start time to be displayed in the editing form. |
| EditedAppointmentCopy | Gets the copy of the appointment currently being edited in the form. Inherited from AppointmentFormControllerBase. |
| EditedPattern | Gets the appointment pattern currently being edited in the Recurrence form. Inherited from AppointmentFormControllerBase. |
| End | Gets or sets the value representing the appointment’s end time within the editing form. Inherited from AppointmentFormControllerBase. |
| HasReminder | Gets or sets a value that indicates whether one or more reminders are associated with the currently edited appointment. Inherited from AppointmentFormControllerBase. |
| IsDateTimeEditable | Informs whether the appointment is in conflict with another, and they are not reconciled. Inherited from AppointmentModificationControllerBase. |
| IsNewAppointment | Checks whether the currently edited appointment is a new and individual object. Inherited from AppointmentFormControllerBase. |
| IsRecurrentAppointment | Gets whether the appointment currently being edited is a recurrent appointment. Inherited from AppointmentModificationControllerBase. |
| IsTimeEnabled | Gets whether the Start and End time editors are enabled on the form. Inherited from AppointmentModificationControllerBase. |
| Label | Gets or sets the label of the appointment currently being edited in the form. |
| LabelId | Obsolete. Gets or sets the identifier of a label, associated with the appointment. Obsolete. Use the Appointment.LabelKey property instead. Inherited from AppointmentModificationControllerBase. |
| LabelKey | Gets or sets the identifier of a label, associated with the appointment. Inherited from AppointmentFormControllerBase. |
| Location | Gets or sets the text, describing the site where the scheduled event happens. Inherited from AppointmentFormControllerBase. |
| NoneString | Returns a string which is used in combo-boxes when none of the available combo-box items are selected. |
| PatternCopy | Obtains a copy of the recurrence pattern for the current appointment. |
| PatternRecurrenceInfo | Obtains recurrence information of the appointment pattern. |
| ReadOnly | Gets or sets whether the current appointment is read-only. Inherited from AppointmentModificationControllerBase. |
| ReminderSpan | Gets or sets the string value used to display the AppointmentFormControllerBase.ReminderTimeBeforeStart value in the editing form. |
| ReminderSpans | Gets the collection of string values used to display reminder time spans available for selection in the editing form. |
| ReminderTimeBeforeStart | Gets or sets the time interval ahead of the appointment’s start time to activate the reminder. Inherited from AppointmentFormControllerBase. |
| 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. Inherited from AppointmentFormControllerBase. |
| ResourceIds | Gets the identifiers of all the resources which are associated with the current appointment. Inherited from AppointmentFormControllerBase. |
| ResourceSharing | Gets a value indicating whether an appointment can be shared between multiple resources. Inherited from AppointmentFormControllerBase. |
| ShouldShowRecurrence | Checks whether the button, which enables an end-user to edit the appointment recurrence, should be visible. |
| ShouldShowRecurrenceButton | Checks whether the button, which enables the end-user to edit the appointment recurrence, should be visible. Inherited from AppointmentFormControllerBase. |
| Start | Gets or sets the value, representing the appointment’s start time within the editing form. Inherited from AppointmentFormControllerBase. |
| Status | Gets or sets the availability status, associated with the appointment. |
| StatusId | Obsolete. Gets or sets the integer identifier of the availability status, associated with the appointment. Obsolete. Use the AppointmentModificationControllerBase.StatusKey property instead. Inherited from AppointmentModificationControllerBase. |
| StatusKey | Gets or sets the identifier of the availability status (Appointment.StatusKey property), associated with the appointment. Inherited from AppointmentFormControllerBase. |
| Storage | Gets the Scheduler Storage holding data of the SchedulerControl, which contains the appointment currently being edited in the form. |
| Subject | Gets or sets the text of the appointment’s subject. Inherited from AppointmentFormControllerBase. |
| TimeZoneEnabled | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from AppointmentModificationControllerBase. |
| TimeZoneHelper | Provides access to an object used for converting time between time zones. |
| TimeZoneId | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from AppointmentModificationControllerBase. |
| TimeZonesEnabled | Gets whether the appointment’s time zone information can be edited in the form. Inherited from AppointmentModificationControllerBase. |
| TimeZoneVisible | Gets or sets whether time zone editor should be displayed. Inherited from AppointmentModificationControllerBase. |
Methods
| Name | Description |
|---|---|
| ApplyChanges() | Copies the values of all the appointment copy’s properties that are currently being edited in the form to the corresponding properties of the source appointment. Inherited from AppointmentModificationControllerBase. |
| ApplyRecurrence(Appointment) | Copies the values of the specified recurrence pattern to the recurrence pattern of the appointment currently being edited in the form. Inherited from AppointmentModificationControllerBase. |
| AreExceptionsPresent() | Returns a value that indicates if the appointment currently being edited in the form is an exception, or it’s a recurrence pattern with exceptions. Inherited from AppointmentModificationControllerBase. |
| AssignRecurrenceInfoRangeProperties(RecurrenceInfo, RecurrenceRange, DateTime, DateTime, Int32, Appointment) | Assigns recurrence info properties depending on the specified recurrence range. Inherited from AppointmentModificationControllerBase. |
| CalculateConflictCount() | Calculates the total count of conflicts where the current appointment conflicts with other appointments. Inherited from AppointmentFormControllerBase. |
| DeleteAppointment() | Deletes the edited appointment. Inherited from AppointmentFormControllerBase. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| IsAppointmentChanged() | Indicates whether the appointment is changed. Inherited from AppointmentModificationControllerBase. |
| IsConflictResolved() | Informs whether the appointment is in conflict with another, and they are not reconciled. Inherited from AppointmentFormControllerBase. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| PrepareToRecurrenceEdit() | Finds and clones the recurrence pattern for the appointment, or creates it if it does not exist. Inherited from AppointmentModificationControllerBase. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| RemoveRecurrence() | Destroys the edited appointment copy. Inherited from AppointmentModificationControllerBase. |
| SetLabel(IAppointmentLabel) | Assigns the label to the current appointment. Inherited from AppointmentModificationControllerBase. |
| SetStatus(IAppointmentStatus) | Assigns the availability status to the appointment. Inherited from AppointmentModificationControllerBase. |
| ToString() | Returns a string that represents the current object. Inherited from Object. |
| ValidateInterval(DateTime, DateTime) static | Checks whether the specified date and time values produce the valid time interval. Inherited from AppointmentModificationControllerBase. |
| ValidateInterval(DateTime, TimeSpan, DateTime, TimeSpan) static | Checks whether the specified date and time values produce the valid time interval. Inherited from AppointmentModificationControllerBase. |
| ValidateLimitInterval(DateTime, TimeSpan, DateTime, TimeSpan) | Checks whether the specified date and time values produce the time interval which falls within the interval specified by the LimitInterval property of the SchedulerControl. Inherited from AppointmentFormControllerBase. |
Events
| Name | Description |
|---|---|
| PropertyChanged | Occurs when a property value of any of the standard appointment properties handled by the AppointmentFormController, changes. Inherited from AppointmentModificationControllerBase. |
See Also