ReminderBase.Dismiss() Method

Switches the reminder off for the associated appointment.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v24.1.Core.dll

NuGet Package: DevExpress.Scheduler.Core

Declaration

C#

public bool Dismiss()

VB.NET

Public Function Dismiss As Boolean

Returns

Type	Description
Boolean	true if the reminder has been successfully switched off; otherwise, false.

Remarks

This method returns false for the reminder associated with a AppointmentType.Normal type appointment, if this appointment cannot be edited.

If the Dismiss is called for the reminder triggered by an appointment occurrence, then the reminder is set for the next occurrence in a chain and the method returns false. If the current occurrence is the last occurrence in a chain, the reminder is dismissed and the Dismiss method returns true.

For an infinite recurring series, this method will always return false.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Dismiss() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-scheduler-create-appointments-on-reminder-alert/CS/ReminderCustomActions/Form1.cs#L59

    // Prevent the event from being fired one more time.
    e.AlertNotifications[0].ActualAppointment.Reminder.Dismiss();
}

VB.NET

winforms-scheduler-create-appointments-on-reminder-alert/VB/ReminderCustomActions/Form1.vb#L61

    ' Prevent the event from being fired one more time.
    e.AlertNotifications(0).ActualAppointment.Reminder.Dismiss()
End Sub