Using events in VB.NET

Background

You can subscribe to events of Ribbon Commander controls by using .NET events or .NET delegates. Here, we show how it can be done by using .NET events. In general you need to take the following steps:

• Declare a member variable of the events source control type WithEvents
• Use Visual Studio to insert the desired event stubs

Example

In this example we will set up a UI that contains an rxButton control and subscribe to all its events.

• Add a new class to your project and name it ButtonEventsUI
• Add the following code to your class

1. Public Class ButtonEventsUI

2.     Private _customUI As rxCustomUI

3.     Private WithEvents _myButton As rxButton

5.     Public Sub New()

6.         ' Instantiate a new rxCustomUI in context 'my_vb_context'

7.         _customUI = rxCustomUI.create("my_vb_context", "My VB.NET context!")

9.         With _customUI

10.             ' Clear old state in the context

11.             .clear()

13.             ' Add a new tab and label it 

14.             With .ribbon.tabs.add(New rxTab())

15.                 .label = "My VB Tab"

17.                 ' Add a new group and label it

18.                 With .groups.add(New rxGroup())

19.                     .label = "My VB Group"

21.                     'Add a new button an label it

22.                     _myButton = .buttons.add(New rxButton)

23.                 End With

24.             End With

26.             ' Render the UI

27.             .refresh()

28.         End With

30.     End Sub

32.     Private Sub _myButton_OnActionEvent(control As LogismiX.Interop.DynamicRibbonX.IRibbonControl) Handles _myButton.OnActionEvent

33.         System.Diagnostics.Debug.Print("_myButton_OnActionEvent clicked")

34.         MessageBox.Show("Hello from VB.NET")

35.     End Sub

37.     Private Sub _myButton_OnGetDescription(control As LogismiX.Interop.DynamicRibbonX.IRibbonControl, ByRef description As String) Handles _myButton.OnGetDescription

38.         System.Diagnostics.Debug.Print("_myButton_OnGetDescription clicked")

39.         description = "My button description"

40.     End Sub

42.     Private Sub _myButton_OnGetEnabled(control As LogismiX.Interop.DynamicRibbonX.IRibbonControl, ByRef enabled As Boolean) Handles _myButton.OnGetEnabled

43.         System.Diagnostics.Debug.Print("_myButton_OnGetEnabled clicked")

44.         enabled = True

45.     End Sub

47.     Private Sub _myButton_OnGetImage(control As LogismiX.Interop.DynamicRibbonX.IRibbonControl, ByRef imageDispOrImageMso As Object) Handles _myButton.OnGetImage

48.         System.Diagnostics.Debug.Print("_myButton_OnGetImage clicked")

49.         imageDispOrImageMso = "AccessTableAssets"

50.     End Sub

52.     Private Sub _myButton_OnGetKeytip(control As LogismiX.Interop.DynamicRibbonX.IRibbonControl, ByRef keytip As String) Handles _myButton.OnGetKeytip

53.         System.Diagnostics.Debug.Print("_myButton_OnGetKeytip clicked")

54.         keytip = "K"

55.     End Sub

57.     Private Sub _myButton_OnGetLabel(control As LogismiX.Interop.DynamicRibbonX.IRibbonControl, ByRef label As String) Handles _myButton.OnGetLabel

58.         System.Diagnostics.Debug.Print("_myButton_OnGetLabel clicked")

59.         label = "My VB Button"

60.     End Sub

62.     Private Sub _myButton_OnGetScreentip(control As LogismiX.Interop.DynamicRibbonX.IRibbonControl, ByRef screentip As String) Handles _myButton.OnGetScreentip

63.         System.Diagnostics.Debug.Print("_myButton_OnGetScreentip clicked")

64.         screentip = "My button screentip"

65.     End Sub

67.     Private Sub _myButton_OnGetShowImage(control As LogismiX.Interop.DynamicRibbonX.IRibbonControl, ByRef showImage As Boolean) Handles _myButton.OnGetShowImage

68.         System.Diagnostics.Debug.Print("_myButton_OnGetShowImage clicked")

69.         showImage = True

70.     End Sub

72.     Private Sub _myButton_OnGetShowLabel(control As LogismiX.Interop.DynamicRibbonX.IRibbonControl, ByRef showLabel As Boolean) Handles _myButton.OnGetShowLabel

73.         System.Diagnostics.Debug.Print("_myButton_OnGetShowLabel clicked")

74.         showLabel = True

75.     End Sub

77.     Private Sub _myButton_OnGetSize(control As LogismiX.Interop.DynamicRibbonX.IRibbonControl, ByRef size As LogismiX.Interop.DynamicRibbonX.RibbonControlSize) Handles _myButton.OnGetSize

78.         System.Diagnostics.Debug.Print("_myButton_OnGetSize clicked")

79.         size = RibbonControlSize.RibbonControlSizeRegular

80.     End Sub

82.     Private Sub _myButton_OnGetSupertip(control As LogismiX.Interop.DynamicRibbonX.IRibbonControl, ByRef supertip As String) Handles _myButton.OnGetSupertip

83.         System.Diagnostics.Debug.Print("_myButton_OnGetSupertip clicked")

84.         supertip = "My button supertip"

85.     End Sub

87.     Private Sub _myButton_OnGetVisible(control As LogismiX.Interop.DynamicRibbonX.IRibbonControl, ByRef visible As Boolean) Handles _myButton.OnGetVisible

88.         System.Diagnostics.Debug.Print("_myButton_OnGetVisible clicked")

89.         visible = True

90.     End Sub

91. End Class

• Modify class ThisAddin in ThisAddin.vb as follows

1. Public Class ThisAddIn

3.     Private _myCustomUI As ButtonEventsUI

5.     Private Sub ThisAddIn_Startup() Handles Me.Startup

6.         _myCustomUI = New ButtonEventsUI()

7.     End Sub

9.     Private Sub ThisAddIn_Shutdown() Handles Me.Shutdown

11.     End Sub

13. End Class

• Run the add-in. If everything went according to plan, the following UI will be created:

  

How to use Visual Studio to insert event stubs automatically

• Select the events source variable in the left list-box at the top of the code window ((1) below)
• Select the desired event in the right list-box at the top of the code window ((2) below)