Share via

BeforeGroupRemove Event

  • Article

Occurs before a new group is removed from the Shortcuts pane, either as a result of user action or through program code. This event is not available in Microsoft Visual Basic Scripting Edition (VBScript).

Subobject**_BeforeGroupRemove(ByVal Group As OutlookBarGroup, Cancel As Boolean)**

*object   * An expression that evaluates to an OutlookBarGroups collection object.

*Group   * Required. The OutlookBarGroup that is being removed.

*Cancel    * Optional. False when the event occurs. If the event procedure sets this argument to True, the group is not removed from the Shortcuts pane.

Example

This Microsoft Visual Basic/Visual Basic for Applications (VBA) example prevents the user from removing a group from the Shortcuts pane. The sample code must be placed in a class module such as ThisOutlookSession, and the Initialize_handler routine must be called before the event procedure can be called by Outlook. You will still be prompted when you try to delete a shortcut. However, the group will not be deleted even if you clicked Yes.

Dim myOlApp As New Outlook.Application
Dim WithEvents myOlGroups As Outlook.OutlookBarGroups
Dim myOlBar As Outlook.OutlookBarPane

Sub Initialize_handler()
    Set myOlBar = myOlApp.ActiveExplorer.Panes.item("OutlookBar")
    Set myOlGroups = myOlBar.Contents.Groups
End Sub

Private Sub myOlGroups_BeforeGroupRemove(ByVal Group As OutlookBarGroup, Cancel As Boolean)
    Cancel = True
End Sub

Applies to | OutlookBarGroups Object

See Also | OutlookBarGroup Object | Remove Method | Using events with Automation