Class SchedulerAppointment

Represents a class which defines the scheduler appointment properties of the scheduler.

Inheritance
System.Object
SchedulerRegionBase
SchedulerAppointment
Implements
System.ComponentModel.INotifyPropertyChanged
Inherited Members
Namespace: Syncfusion.Maui.Scheduler
Assembly: Syncfusion.Maui.Scheduler.dll
Syntax
public class SchedulerAppointment : SchedulerRegionBase, INotifyPropertyChanged, IThemeElement

Constructors

SchedulerAppointment()

Initializes a new instance of the SchedulerAppointment class.

Declaration
public SchedulerAppointment()

Fields

BackgroundProperty

Identifies the Background dependency property.

Declaration
public static readonly BindableProperty BackgroundProperty
Field Value
Type Description
Microsoft.Maui.Controls.BindableProperty

Identifies the Background bindable property.

Properties

ActualEndTime

Gets the internal end time which is converted based on end 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

Background

Gets or sets the background color for an appointment in the SfScheduler.

Declaration
public Brush Background { get; set; }
Property Value
Type
Microsoft.Maui.Controls.Brush

DataItem

Gets the data item associated with the SchedulerAppointment.

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

An object that contains properties to hold the detailed information about the data of SchedulerAppointmentMapping, which will be rendered in SfScheduler.

EndTimeZone

Gets or sets the end time zone for the appointment.

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

Id

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

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 this SchedulerAppointment is all day.

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

IsReadOnly

Gets or sets a value indicating whether the appointment is read-only or not.

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

The default value is false.

Location

Gets or sets the Location value for Scheduler Appointment to describe the location of the appointment in scheduler.

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

This property takes the System.String value.

Notes

Gets or sets the Notes for Scheduler Appointment to describe a note about the appointment in scheduler.

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

This property takes the System.String value.

RecurrenceId

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

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

Reminders

Gets or sets the reminders of an appointment which is used to notify the reminder alert.

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

StartTimeZone

Gets or sets the start time zone for the appointment.

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

Stroke

Gets or sets the stroke for an appointment border in the SfScheduler.

Declaration
public Color Stroke { get; set; }
Property Value
Type
Microsoft.Maui.Graphics.Color
Remarks

If the Stroke value is set, then appointment border stroke will be set to Stroke value. If the Stroke value is Transparent, and if the AppointmentBorderStyle stroke value is set then AppointmentBorderStyle stroke value will be set to appointment. Otherwise, the default AppointmentBorderStyle stroke value will be set.

Subject

Gets or sets the Subject value for Scheduler Appointment to describe the appointments subject in scheduler.

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

TextColor

Gets or sets the text color for an appointment in the SfScheduler.

Declaration
public Color TextColor { get; set; }
Property Value
Type
Microsoft.Maui.Graphics.Color
Remarks

If the TextColor value is set, then appointment foreground will be set to TextColor value. If the TextColor value is Transparent, and if the AppointmentTextStyle text color value is set then AppointmentTextStyle text color value will be set to appointment. Otherwise, the appointment Background luminosity will be used to determine the default appointment AppointmentTextStyle text color value. If the background color of the appointment is light, the appointment text color will be black; otherwise, the text color will be white.

Type

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

Declaration
public SchedulerAppointmentType Type { get; }
Property Value
Type
SchedulerAppointmentType

Implements

System.ComponentModel.INotifyPropertyChanged