Class ScheduleAppointment

Represents a class which defines appointments in schedule control.

Inheritance
System.Object
NotificationObject
ScheduleAppointment
Implements
System.ComponentModel.INotifyPropertyChanged
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.Scheduler
Assembly: Syncfusion.Scheduler.WinUI.dll
Syntax
public class ScheduleAppointment : NotificationObject, INotifyPropertyChanged, IDisposable

Constructors

ScheduleAppointment()

Initializes a new instance of the ScheduleAppointment class.

Declaration
public ScheduleAppointment()

Properties

ActualEndTime

Gets the internal end time which is converted based on start time zone applied.

Declaration
public DateTime ActualEndTime { get; }
Property Value
Type
System.DateTime

ActualStartTime

Gets the internal start time which is converted based on start time zone applied.

Declaration
public DateTime ActualStartTime { get; }
Property Value
Type
System.DateTime

AppointmentBackground

Gets or sets the appointment color.

Declaration
public Brush AppointmentBackground { get; set; }
Property Value
Type
Microsoft.UI.Xaml.Media.Brush

Data

Gets the data object associated with ScheduleAppointment.

Declaration
public object Data { get; }
Property Value
Type
System.Object
Remarks

Scheduler creates ScheduleAppointment for each item in ItemsSource and Data property holds the item for which SchedulerAppointment created.

EndTime

Gets or sets the end date and time of the appointment.

Declaration
public DateTime EndTime { get; set; }
Property Value
Type
System.DateTime

EndTimeZone

Gets or sets time zone for the end time of the appointment.

Declaration
public string EndTimeZone { get; set; }
Property Value
Type
System.String

Foreground

Gets or sets the foreground for the AppointmentControl.

Declaration
public Brush Foreground { get; set; }
Property Value
Type
Microsoft.UI.Xaml.Media.Brush

Id

Gets or sets an unique Id for referring event or appointment in ItemsSource.

Declaration
public object Id { get; set; }
Property Value
Type
System.Object
Remarks

The occurrences of pattern appointment have same Id of pattern recurrence appointment. The exception appointment should have different Id with pattern recurrence appointment.

IsAllDay

Gets or sets a value indicating whether the appointment's duration is equal one day or not.

Declaration
public bool IsAllDay { get; set; }
Property Value
Type
System.Boolean

IsRecursive

Gets a value indicating whether the appointment is recurrence appointment or not.

Declaration
public bool IsRecursive { get; }
Property Value
Type
System.Boolean

Location

Gets or sets the location for an appointment.

Declaration
public string Location { get; set; }
Property Value
Type
System.String

Notes

Gets or sets the notes for an appointment.

Declaration
public string Notes { get; set; }
Property Value
Type
System.String

RecurrenceExceptionDates

Gets or sets the properties for maintaining recurrence rule exception Dates.

Declaration
public ObservableCollection<DateTime> RecurrenceExceptionDates { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<System.DateTime>

RecurrenceId

Gets or sets the Id which is used to maintain the pattern recurrence Id that added in ItemsSource for creating the exception recurrence appointment.

Declaration
public object RecurrenceId { get; set; }
Property Value
Type
System.Object
See Also

RecurrenceRule

Gets or sets a value indicating whether the appointment should be recursive.

Declaration
public string RecurrenceRule { get; set; }
Property Value
Type
System.String

Reminders

Gets or sets the reminders of an appointment which is used to trigger the ReminderAlertOpening event.

Declaration
public ObservableCollection<SchedulerReminder> Reminders { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<SchedulerReminder>
See Also

ResourceIdCollection

Gets or sets Id’s of resources that shares the appointment. Based on this Id the appointments are grouped and arranged under each resource in view.

Declaration
public ObservableCollection<object> ResourceIdCollection { get; set; }
Property Value
Type
System.Collections.ObjectModel.ObservableCollection<System.Object>
See Also

StartTime

Gets or sets the start date and time of the appointment.

Declaration
public DateTime StartTime { get; set; }
Property Value
Type
System.DateTime

StartTimeZone

Gets or sets time zone for the start time of the appointment.

Declaration
public string StartTimeZone { get; set; }
Property Value
Type
System.String

Subject

Gets or sets the subject for the appointment.

Declaration
public string Subject { get; set; }
Property Value
Type
System.String

Type

Gets the type of appointment.

Declaration
public AppointmentType Type { get; }
Property Value
Type
AppointmentType
Remarks

Appointment type denotes whether it is normal appointment or pattern (recurring) appointment or occurrence of pattern appointment or changed occurrence of pattern appointment.

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()

Dispose(Boolean)

Method to dispose the unmanaged resources.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

The Disposing.

Implements

System.ComponentModel.INotifyPropertyChanged
System.IDisposable