WinUI

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SchedulerReminder - WinUI API Reference | Syncfusion ScheduleAppointment. ">

    Show / Hide Table of Contents

    Class SchedulerReminder

    Represents a class to add reminders for an ScheduleAppointment.

    Inheritance
    System.Object
    NotificationObject
    SchedulerReminder
    Implements
    System.ComponentModel.INotifyPropertyChanged
    Inherited Members
    NotificationObject.RaisePropertyChanged(String)
    NotificationObject.RaisePropertyChanged(String[])
    NotificationObject.PropertyChanged
    Namespace: Syncfusion.UI.Xaml.Scheduler
    Assembly: Syncfusion.Scheduler.WinUI.dll
    Syntax
    public class SchedulerReminder : NotificationObject, INotifyPropertyChanged

    Constructors

    SchedulerReminder()

    Declaration
    public SchedulerReminder()

    Properties

    Appointment

    Gets the appointment details for which the reminder is created.

    Declaration
    public ScheduleAppointment Appointment { get; }
    Property Value
    Type Description
    ScheduleAppointment
    Remarks

    A recurring appointment will return its occurrence of appointment.

    See Also
    Data
    AppointmentMapping
    ReminderMapping

    Data

    Gets the reminder data object associated with SchedulerReminder.

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

    When ScheduleAppointment is created based on AppointmentMapping from fields of data object, then SchedulerReminder will be created from the field mapping of Reminders and ReminderMapping.

    See Also
    Reminders
    ReminderMapping

    IsDismissed

    Gets or sets a value indicating whether the reminder is dismissed.

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

    When a reminder of a recurring appointment is dismissed, then the reminder is set for the next occurrence in a series.If the current occurrence is the last occurrence in a chain, the reminder is dismissed.

    ReminderAlertTime

    Gets or sets the reminder time that decides when to show a reminder alert of the appointment.

    Declaration
    public DateTime ReminderAlertTime { get; set; }
    Property Value
    Type Description
    System.DateTime
    Remarks

    The appointment reminder alert time calculated as follows (ReminderAlertTime = ScheduleAppointment.ActualStartTime - ReminderTimeInterval). This reminder alert time will be updated based on the snoozed reminder time (ReminderAlertTime = DateTime.Now + SnoozeTimeSpan). The ReminderAlertTime value specifies when an appointment reminder should be notified. The ReminderTimeInterval value is displayed in the appointment editor window's reminder editor value.

    See Also
    ReminderTimeInterval
    IsDismissed

    ReminderTimeInterval

    Gets or sets the time interval that decides to notify the reminder alert before the appointment’s start time.

    Declaration
    public TimeSpan ReminderTimeInterval { get; set; }
    Property Value
    Type Description
    System.TimeSpan
    See Also
    Reminders

    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

    Can dispose.

    Implements

    System.ComponentModel.INotifyPropertyChanged
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved