TcxSchedulerReminders Members
The TcxSchedulerReminders class manages timed out reminders, and also allows the Reminders window to be invoked.Constructors
Name | Description |
---|---|
Create(TcxCustomSchedulerStorage) | Initializes a new instance of the TcxSchedulerReminders class with specified settings. |
Create(TPersistent) | Initializes a new instance of the TcxInterfacedPersistent class with specified settings. Inherited from TcxInterfacedPersistent. |
Properties
Name | Description |
---|---|
Active | Activates or deactivates reminders. |
Count | Gets the number of TcxSchedulerReminder objects in the TcxSchedulerReminders collection. |
DefaultMinutesBeforeStart | Specifies the default value of the reminder time in minutes of the TcxSchedulerEvent.ReminderMinutesBeforeStart property. |
DefaultReminder | Specifies the default value of the TcxSchedulerEvent.Reminder property. |
Items | Provides indexed access to the TcxSchedulerReminder objects in the TcxSchedulerReminders collection. |
Owner | Provides access to the control or its object to which the persisted settings belong. Inherited from TcxInterfacedPersistent. |
ReminderByResource | Specifies whether user events are shown by resources when displayed in the Reminders window. |
ReminderWindow | References the Reminders window instance when the Reminders window is initialized. |
ReminderWindowLookAndFeel | Represents look and feel settings for the Reminders window. |
ShowResourcesInReminderWindow | Specifies whether resource names are displayed in the Reminders window’s alert list. |
Storage | Represents the persistence manager component. |
TimeZone | Specifies the time zone for the reminder. |
TimeZoneDaylightSaving | Specifies whether daylight saving time is applied to the reminder. |
UseReminderWindow | Specifies whether the Reminders window is displayed when a reminder alerts. |
Methods
Name | Description |
---|---|
Assign(TPersistent) | Inherited from TPersistent. |
AssignTo(TPersistent) | Inherited from TPersistent. |
BeginUpdate | |
DismissAll | Removes TcxSchedulerReminder instances from the TcxSchedulerReminders collection, and deletes the reminder flags from the associated user events. |
EndUpdate | |
Equals(TObject) | Inherited from TObject. |
GetEventDueTimeText(TcxSchedulerReminder,TDateTime) | Returns a formatted time string as the time interval between the start time of the user event that the AReminder reminder relates to and the ATime bound. |
GetHashCode | Inherited from TObject. |
GetNamePath | Inherited from TPersistent. |
GetOwner | Inherited from TPersistent. |
HasReminders | Checks if there are reminders in the TcxSchedulerReminders collection. |
HideReminderWindow | Closes the Reminders window. |
IsLocked | Determines whether the TcxSchedulerReminders collection can be updated. |
IsReminderByResourceAvailable | |
IsReminderValid(TcxSchedulerReminder) | |
IsReminderWindowShown | Determines whether the Reminders window is currently displayed. |
QueryInterface(TGUID,Untyped) | Inherited from TInterfacedPersistent. |
Refresh | Updates the TcxSchedulerReminders collection. |
ShowReminderWindow | Invokes the Reminders window. |
SnoozeAll(TDateTime) | Notifies the scheduler to defer triggering of all the TcxSchedulerReminder reminders, which are currently stored in the TcxSchedulerReminders collection for the specified ASnoozeTime interval (regarding to the current time). |
ToString | Inherited from TObject. |
Events
Name | Description |
---|---|
OnAlertReminder | Allows you to customize the AReminder’s alert behavior. |
OnDismissReminder | Fires when the AReminder reminder is about to be dismissed. |
OnGetEventDueTimeText | Fires when a formatted time string is about to be returned by the GetEventDueTimeText method. |
OnGetReminderWindowCaption | Fires when the Reminders window is about to be opened. |
OnHideReminderWindow | Fires when the Reminders window is about to be closed by an end-user or by the HideReminderWindow method if invoked. |
OnOpenEvent | Fires when the Open Item button (located in the Reminders window) has been clicked. |
OnShowReminderWindow | Fires when the Reminders window is being opened. |
OnSnoozeReminder | Fires when the AReminder reminder is about to be snoozed. |
See Also