Class ScheduleAppointment

Represents a schedule appointment.

Inheritance

System.Object

ScheduleAppointment

Implements

System.ComponentModel.INotifyPropertyChanged

Namespace: Syncfusion.UI.Xaml.Schedule

Assembly: Syncfusion.SfSchedule.UWP.dll

Syntax

public class ScheduleAppointment : DependencyObject, INotifyPropertyChanged

Constructors

ScheduleAppointment()

Initializes a new instance of the ScheduleAppointment class.

Declaration

public ScheduleAppointment()

Fields

AllDayProperty

Using a DependencyProperty as the backing store for AllDay. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty AllDayProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

AppointmentBackgroundProperty

Using a DependencyProperty as the backing store for AppointmentBackground. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty AppointmentBackgroundProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

EndTimeProperty

Using a DependencyProperty as the backing store for EndTime. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty EndTimeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

EndTimeZoneProperty

Using a DependencyProperty as the backing store for EndTimeZone. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty EndTimeZoneProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

IsRecursiveProperty

Using a DependencyProperty as the backing store for IsRecursive. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty IsRecursiveProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

IsSelectedProperty

Using a DependencyProperty as the backing store for IsSelected. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty IsSelectedProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

LocationProperty

Using a DependencyProperty as the backing store for Location. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty LocationProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

NotesProperty

Using a DependencyProperty as the backing store for Notes. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty NotesProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ObjectIDProperty

Using a DependencyProperty as the backing store for ObjectID. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ObjectIDProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ReadOnlyProperty

Using a DependencyProperty as the backing store for ReadOnly. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ReadOnlyProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ReadOnlyVisibilityProperty

Using a DependencyProperty as the backing store for ReadOnlyVisibility. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ReadOnlyVisibilityProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

RecurrenceIDProperty

Using a DependencyProperty as the backing store for RecurrenceID. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty RecurrenceIDProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

RecurrenceProperitesProperty

Using a DependencyProperty as the backing store for RecurrenceProperites. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty RecurrenceProperitesProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

RecurrenceRuleProperty

Using a DependencyProperty as the backing store for RecurrenceRule. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty RecurrenceRuleProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ReminderTimeProperty

Using a DependencyProperty as the backing store for ReminderTime. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ReminderTimeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ResourceCollectionProperty

Using a DependencyProperty as the backing store for ResourceCollection. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ResourceCollectionProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StartTimeProperty

Using a DependencyProperty as the backing store for StartTime. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty StartTimeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StartTimeZoneProperty

Using a DependencyProperty as the backing store for StartTimeZone. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty StartTimeZoneProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StatusProperty

Using a DependencyProperty as the backing store for Status. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty StatusProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SubjectProperty

Using a DependencyProperty as the backing store for Subject. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SubjectProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

Properties

AllDay

Gets or sets the value indicating whether the appointment should be extended for an entire day.

Declaration

public bool AllDay { get; set; }

Property Value

Type
System.Boolean

Examples

using System; using Syncfusion.UI.Xaml.Schedule; namespace ScheduleDemo { public sealed partial class ScheduleSample { public ScheduleSample() { this.InitializeComponent(); SfSchedule schedule = new SfSchedule(); ScheduleAppointment appointment = new ScheduleAppointment(); appointment.StartTime = DateTime.Now.AddHours(1); appointment.EndTime = DateTime.Now.AddHours(2); appointment.AllDay = true; schedule.Appointments.Add(appointment); Layout.Children.Add(schedule); } } }

AppointmentBackground

Gets or sets Brush that provides the background for an appointment.

Declaration

public Brush AppointmentBackground { get; set; }

Property Value

Type
Windows.UI.Xaml.Media.Brush

Examples

using System; using Windows.UI; using Windows.UI.Xaml.Media; using Syncfusion.UI.Xaml.Schedule; namespace ScheduleDemo { public sealed partial class ScheduleSample { public ScheduleSample() { this.InitializeComponent(); SfSchedule schedule = new SfSchedule(); ScheduleAppointment appointment = new ScheduleAppointment(); appointment.StartTime = DateTime.Now.AddHours(1); appointment.EndTime = DateTime.Now.AddHours(2); appointment.AppointmentBackground = new SolidColorBrush(Colors.Orange); schedule.Appointments.Add(appointment); Layout.Children.Add(schedule); } } }

EndTime

Gets the sets the appointment's end time.

Declaration

public DateTime EndTime { get; set; }

Property Value

Type
System.DateTime

Examples

using System; using Syncfusion.UI.Xaml.Schedule; namespace ScheduleDemo { public sealed partial class ScheduleSample { public ScheduleSample() { this.InitializeComponent(); SfSchedule schedule = new SfSchedule(); ScheduleAppointment appointment = new ScheduleAppointment(); appointment.StartTime = DateTime.Now.AddHours(1); appointment.EndTime = DateTime.Now.AddHours(2); schedule.Appointments.Add(appointment); Layout.Children.Add(schedule); } } }

EndTimeZone

Gets or sets the time zone for appointment's end time.

Declaration

public TimeZone EndTimeZone { get; set; }

Property Value

Type
TimeZone

Examples

using System; using Syncfusion.UI.Xaml.Schedule; namespace ScheduleDemo { public sealed partial class ScheduleSample { public ScheduleSample() { this.InitializeComponent(); SfSchedule schedule = new SfSchedule(); ScheduleAppointment appointment = new ScheduleAppointment(); appointment.StartTime = DateTime.Now.AddHours(1); appointment.EndTime = DateTime.Now.AddHours(2); appointment.EndTimeZone = new TimeZone { TimeZoneValue = TimeZoneInfo.Local.ToString() }; schedule.Appointments.Add(appointment); Layout.Children.Add(schedule); } } }

IsRecursive

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

Declaration

public bool IsRecursive { get; set; }

Property Value

Type
System.Boolean

Examples

using System; using Syncfusion.UI.Xaml.Schedule; namespace ScheduleWinRT { public sealed partial class ScheduleSample { public ScheduleSample() { this.InitializeComponent(); SfSchedule schedule = new SfSchedule(); schedule.ScheduleType = ScheduleType.Month; ScheduleAppointment appointment = new ScheduleAppointment { Subject = "Meeting", StartTime = DateTime.Now.AddHours(1), EndTime = DateTime.Now.AddHours(2) }; RecurrenceProperties RecProp = new RecurrenceProperties { RecurrenceType = RecurrenceType.Daily, IsDailyEveryNDays = false, DailyNDays = 2, IsRangeNoEndDate = true, RangeEndDate = DateTime.Now.AddDays(10), RangeRecurrenceCount = 100 }; // Generating RRule using ScheduleHelper appointment.RecurrenceRule = ScheduleHelper.RRuleGenerator(RecProp, appointment.StartTime, appointment.EndTime); appointment.IsRecursive = true; schedule.Appointments.Add(appointment); Grid.Children.Add(schedule); } } }

IsSelected

Gets a value indicating whether the appointment gets selected.

Declaration

public bool IsSelected { 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

Examples

using System; using Syncfusion.UI.Xaml.Schedule; namespace ScheduleDemo { public sealed partial class ScheduleSample { public ScheduleSample() { this.InitializeComponent(); SfSchedule schedule = new SfSchedule(); ScheduleAppointment appointment = new ScheduleAppointment(); appointment.StartTime = DateTime.Now.AddHours(1); appointment.EndTime = DateTime.Now.AddHours(2); appointment.Location = "Chennai"; schedule.Appointments.Add(appointment); Layout.Children.Add(schedule); } } }

Notes

Gets or sets the notes for an appointment.

Declaration

public string Notes { get; set; }

Property Value

Type
System.String

Examples

using System; using Syncfusion.UI.Xaml.Schedule; namespace ScheduleDemo { public sealed partial class ScheduleSample { public ScheduleSample() { this.InitializeComponent(); SfSchedule schedule = new SfSchedule(); ScheduleAppointment appointment = new ScheduleAppointment(); appointment.StartTime = DateTime.Now.AddHours(1); appointment.EndTime = DateTime.Now.AddHours(2); appointment.Notes = "Inauguration"; schedule.Appointments.Add(appointment); Layout.Children.Add(schedule); } } }

ObjectID

Gets an unique ID for referring items in ItemsSource of Schedule.

Declaration

public double ObjectID { get; }

Property Value

Type
System.Double

ReadOnly

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

Declaration

public bool ReadOnly { get; set; }

Property Value

Type
System.Boolean

Examples

using System; using Syncfusion.UI.Xaml.Schedule; namespace ScheduleDemo { public sealed partial class ScheduleSample { public ScheduleSample() { this.InitializeComponent(); SfSchedule schedule = new SfSchedule(); ScheduleAppointment appointment = new ScheduleAppointment(); appointment.StartTime = DateTime.Now.AddHours(1); appointment.EndTime = DateTime.Now.AddHours(2); appointment.ReadOnly = true; schedule.Appointments.Add(appointment); Layout.Children.Add(schedule); } } }

ReadOnlyVisibility

Gets the visibility of read only appointment.

Declaration

public Visibility ReadOnlyVisibility { get; }

Property Value

Type
Windows.UI.Xaml.Visibility

RecurrenceID

Gets an unique ID for referring recurrence appointment.

Declaration

public double RecurrenceID { get; }

Property Value

Type
System.Double

RecurrenceProperites

Gets the recurrence properties of schedule appointments.

Declaration

public RecurrenceProperties RecurrenceProperites { get; }

Property Value

Type
RecurrenceProperties

RecurrenceRule

Gets or sets the rule for recurrence appointments.

Declaration

public string RecurrenceRule { get; set; }

Property Value

Type
System.String

Remarks

To set recurring appointment, IsRecursive of schedule appointment must be set as true.

Examples

ReminderTime

Gets or sets the reminder time for appointments

Declaration

public ReminderTimeType ReminderTime { get; set; }

Property Value

Type
ReminderTimeType

Examples

using System; using Syncfusion.UI.Xaml.Schedule; namespace ScheduleDemo { public sealed partial class ScheduleSample { public ScheduleSample() { this.InitializeComponent(); SfSchedule schedule = new SfSchedule(); ScheduleAppointment appointment = new ScheduleAppointment(); appointment.StartTime = DateTime.Now.AddHours(1); appointment.EndTime = DateTime.Now.AddHours(2); appointment.ReminderTime = ReminderTimeType.OneHour; schedule.Appointments.Add(appointment); Layout.Children.Add(schedule); } } }

ResourceCollection

Declaration

public ObservableCollection<object> ResourceCollection { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<System.Object>

StartTime

Gets the sets the appointment's start time.

Declaration

public DateTime StartTime { get; set; }

Property Value

Type
System.DateTime

Examples

using System; using Syncfusion.UI.Xaml.Schedule; namespace ScheduleDemo { public sealed partial class ScheduleSample { public ScheduleSample() { this.InitializeComponent(); SfSchedule schedule = new SfSchedule(); ScheduleAppointment appointment = new ScheduleAppointment(); appointment.StartTime = DateTime.Now.AddHours(1); appointment.EndTime = DateTime.Now.AddHours(2); schedule.Appointments.Add(appointment); Layout.Children.Add(schedule); } } }

StartTimeZone

Gets or sets the time zone for appointment's start time.

Declaration

public TimeZone StartTimeZone { get; set; }

Property Value

Type
TimeZone

Examples

using System; using Syncfusion.UI.Xaml.Schedule; namespace ScheduleDemo { public sealed partial class ScheduleSample { public ScheduleSample() { this.InitializeComponent(); SfSchedule schedule = new SfSchedule(); ScheduleAppointment appointment = new ScheduleAppointment(); appointment.StartTime = DateTime.Now.AddHours(1); appointment.StartTimeZone = new TimeZone { TimeZoneValue = TimeZoneInfo.Local.ToString() }; appointment.EndTime = DateTime.Now.AddHours(2); schedule.Appointments.Add(appointment); Layout.Children.Add(schedule); } } }

Status

Gets or sets the appointment's status.

Declaration

public ScheduleAppointmentStatus Status { get; set; }

Property Value

Type
ScheduleAppointmentStatus

Examples

using System; using Syncfusion.UI.Xaml.Schedule; namespace ScheduleDemo { public sealed partial class ScheduleSample { public ScheduleSample() { this.InitializeComponent(); SfSchedule schedule = new SfSchedule(); ScheduleAppointment appointment = new ScheduleAppointment(); appointment.StartTime = DateTime.Now.AddHours(1); appointment.EndTime = DateTime.Now.AddHours(2); appointment.Status = schedule.AppointmentStatusCollection[0]; schedule.Appointments.Add(appointment); Layout.Children.Add(schedule); } } }

Subject

Gets or sets the subject for an appointment.

Declaration

public string Subject { get; set; }

Property Value

Type
System.String

Examples

using System; using Syncfusion.UI.Xaml.Schedule; namespace ScheduleDemo { public sealed partial class ScheduleSample { public ScheduleSample() { this.InitializeComponent(); SfSchedule schedule = new SfSchedule(); ScheduleAppointment appointment = new ScheduleAppointment(); appointment.StartTime = DateTime.Now.AddHours(1); appointment.EndTime = DateTime.Now.AddHours(2); appointment.Subject = "Meeting"; schedule.Appointments.Add(appointment); Layout.Children.Add(schedule); } } }

Events

AllDayChanged

Occurs when a schedule all-day appointment is changed.

Declaration

public event PropertyChangedCallback AllDayChanged

Event Type

Type
Windows.UI.Xaml.PropertyChangedCallback

LocationChanged

Occurs when location of schedule appointment is changed.

Declaration

public event PropertyChangedCallback LocationChanged

Event Type

Type
Windows.UI.Xaml.PropertyChangedCallback

PropertyChanged

Occurs when a ScheduleAppointment's property is changed.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type
System.ComponentModel.PropertyChangedEventHandler

SubjectChanged

Occurs when subject of schedule appointment is changed.

Declaration

public event PropertyChangedCallback SubjectChanged

Event Type

Type
Windows.UI.Xaml.PropertyChangedCallback

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods

DateTimeExtension.ToDateTime(Object)