Make CommandBarButtonEventArgs safe by copying properties of button rather than marshaling the button across event boundaries.

Author: bclothier

Rubberduck.Core/UI/Command/MenuItems/CommandBars/AppCommandBarBase.cs

@@ -224,7 +224,7 @@ private void child_Click(object sender, CommandBarButtonClickEventArgs e)
             ICommandMenuItem item;
             try
             {
-                item = _items.Select(kvp => kvp.Key).SingleOrDefault(menu => menu.GetType().FullName == e.Control.Tag);
+                item = _items.Select(kvp => kvp.Key).SingleOrDefault(menu => menu.GetType().FullName == e.Tag);
             }
             catch (COMException exception)
             {
@@ -236,7 +236,7 @@ private void child_Click(object sender, CommandBarButtonClickEventArgs e)
                 return;
             }
 
-            Logger.Debug("({0}) Executing click handler for commandbar item '{1}', hash code {2}", GetHashCode(), e.Control.Caption, e.Control.Target.GetHashCode());
+            Logger.Debug("({0}) Executing click handler for commandbar item '{1}', hash code {2}", GetHashCode(), e.Caption, e.TargetHashCode);
             item.Command.Execute(null);
         }
     }

Rubberduck.Core/UI/Command/MenuItems/ParentMenus/ParentMenuItemBase.cs

@@ -181,13 +181,13 @@ private ICommandBarControl InitializeChildControl(ICommandMenuItem item)
 
         private void child_Click(object sender, CommandBarButtonClickEventArgs e)
         {
-            var item = _items.Select(kvp => kvp.Key).SingleOrDefault(menu => e.Control.Tag.EndsWith(menu.GetType().Name)) as ICommandMenuItem;
+            var item = _items.Select(kvp => kvp.Key).SingleOrDefault(menu => e.Tag.EndsWith(menu.GetType().Name)) as ICommandMenuItem;
             if (item == null)
             {
                 return;
             }
 
-            Logger.Debug("({0}) Executing click handler for menu item '{1}', hash code {2}", GetHashCode(), e.Control.Caption, e.Control.Target.GetHashCode());
+            Logger.Debug("({0}) Executing click handler for menu item '{1}', hash code {2}", GetHashCode(), e.Caption, e.TargetHashCode);
             item.Command.Execute(null);
         }
     }

Rubberduck.VBEEditor/SafeComWrappers/Office/CommandBarButtonClickEventArgs.cs

@@ -7,10 +7,14 @@ public class CommandBarButtonClickEventArgs : EventArgs
     {
         public CommandBarButtonClickEventArgs(ICommandBarButton control)
         {
-            Control = control;
+            Tag = control.Tag;
+            Caption = control.Caption;
+            TargetHashCode = control.Target.GetHashCode();
         }
 
-        public ICommandBarButton Control { get; }
+        public string Tag { get; }
+        public string Caption { get; }
+        public int TargetHashCode { get; }
 
         public bool Cancel { get; set; }
         public bool Handled { get; set; } // Only used in VB6

Rubberduck.VBEditor.VB6/SafeComWrappers/Office/CommandBarButton.cs

@@ -277,14 +277,17 @@ void VB._dispCommandBarControlEvents.Click(object Ctrl, ref bool Handled, ref bo
             {                
                 return;
             }
-            var button = new CommandBarButton((MSO.CommandBarButton)Ctrl, _vbe);
 
-            System.Diagnostics.Debug.Assert(handler.GetInvocationList().Length == 1, "Multicast delegate is registered more than once.");
+            using (var button = new CommandBarButton((MSO.CommandBarButton) Ctrl, _vbe))
+            {
+                System.Diagnostics.Debug.Assert(handler.GetInvocationList().Length == 1,
+                    "Multicast delegate is registered more than once.");
 
-            var args = new CommandBarButtonClickEventArgs(button);
-            handler.Invoke(this, args);
-            CancelDefault = args.Cancel;
-            Handled = args.Handled;
+                var args = new CommandBarButtonClickEventArgs(button);
+                handler.Invoke(this, args);
+                CancelDefault = args.Cancel;
+                Handled = args.Handled;
+            }
         }
 
         public event EventHandler Disposing;

Rubberduck.VBEditor.VBA/SafeComWrappers/Office/CommandBarButton.cs

@@ -314,19 +314,21 @@ public event EventHandler<CommandBarButtonClickEventArgs> Click
 
         void MSO._CommandBarButtonEvents.Click(MSO.CommandBarButton Ctrl, ref bool CancelDefault)
         {
-            var button = new CommandBarButton(Ctrl);
             var handler = _click;
             if (handler == null || IsWrappingNullReference)
             {
-                button.Dispose();
                 return;
             }
 
-            System.Diagnostics.Debug.Assert(handler.GetInvocationList().Length == 1, "Multicast delegate is registered more than once.");
+            using (var button = new CommandBarButton(Ctrl))
+            {
+                System.Diagnostics.Debug.Assert(handler.GetInvocationList().Length == 1,
+                    "Multicast delegate is registered more than once.");
 
-            var args = new CommandBarButtonClickEventArgs(button);
-            handler.Invoke(this, args);
-            CancelDefault = args.Cancel;
+                var args = new CommandBarButtonClickEventArgs(button);
+                handler.Invoke(this, args);
+                CancelDefault = args.Cancel;
+            }
         }
 
         public event EventHandler Disposing;