Reminder Object

Microsoft Outlook Visual Basic

Reminder Object

         
Reminders Reminder
NameSpace

Represents a Microsoft Outlook reminder. Reminders allow users to keep track of upcoming appointments by scheduling a pop-up dialog box to appear at a given time. In addition to appointments, reminders can occur for tasks, contacts and e-mail messages.

Using the Reminder object

Use Reminders(index), where index is the name or index number of the reminder, to return a single Reminder object. The following example displays the caption of the first reminder in the collection.

Sub ViewReminderInfo()
'Displays information about first reminder in collection

    Dim olApp As Outlook.Application
    Dim objRem As Reminder

    Set olApp = Outlook.Application
    'If there are reminders, display message
    If olApp.Reminders.Count <> 0 Then
        Set objRem = olApp.Reminders.Item(1)
        MsgBox "The caption of the first reminder in the collection is: " & _
               objRem.Caption
    Else
        MsgBox "There are no reminders in the collection."

    End If

End Sub

Reminders are created programmatically when a new Microsoft Outlook item, such as an AppointmentItem object, is created and the item 's ReminderSet property is set to True. Use the item's ReminderTime property to set the time in minutes at which the reminder will occur. The following example creates a new meeting and sets the ReminderSet property to True, adding a new Reminder object to the Reminders collection.

Sub AddMeeting()
'Adds a new meeting and reminder to the reminders collection

    Dim olApp As Outlook.Application
    Dim objMeet As AppointmentItem

    Set olApp = Outlook.Application
    Set objMeet = olApp.CreateItem(olAppointmentItem)

    objMeet.ReminderSet = True
    objMeet.Subject = "Tuesday's meeting"

End Sub

Use the Reminders collection's Remove method to remove a Reminder object from the collection. Once a reminder is removed from its associated item, the AppointmentItem object's ReminderSet property is set to False.