Difference between revisions of "Creating our first button in VBA"

From Ribbon Commander Documentation
Jump to: navigation, search
(→‎Complete Example Code)
 
(38 intermediate revisions by the same user not shown)
Line 3: Line 3:
  
 
== Creating a button ==
 
== Creating a button ==
−
<syntaxhighlight lang="vb" line>
+
* Enter the code below in a standard VBA module
−
Public Sub CreateMyUI()
+
  
−
     With rxCustomUI.defaultInstance
+
<syntaxhighlight lang="vb" line>
 +
Public Sub CreateMyUI3()
 +
      
 +
    Dim myCustomUI As rxCustomUI
 +
    Set myCustomUI = rxCustomUI.defaultInstance
 +
   
 +
    With myCustomUI
 
         ' Clear old state
 
         ' Clear old state
 
         .Clear
 
         .Clear
Line 20: Line 25:
 
                 With .Buttons.Add(New rxButton)
 
                 With .Buttons.Add(New rxButton)
 
                     .Label = "My Button"
 
                     .Label = "My Button"
−
                   
 
 
                 End With
 
                 End With
 
                  
 
                  
Line 33: Line 37:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
== Code Analysis ==
+
* Run the sub to create a button labeled 'My Button' (which belongs to a group labeled 'My Group' which, in turn' belongs to a tab labeled 'My Tab')
 +
*: [[image: FirstButton.png|link=]]
 +
 
 +
== Code Analysis I ==
 +
<syntaxhighlight lang="vb" line start="13">
 +
' Add a new group to our tab
 +
With .groups.Add(New rxGroup)
 +
    .Label = "My Group"
 +
    '...
 +
End With
 +
</syntaxhighlight>
 +
 
 +
Each [[rxTab]] object has a collection of [[rxGroup]] objects (accessible through its ''groups'' property). Here we add a new group to our tab's groups and label it 'My Group'
 +
 
 +
 
 +
<syntaxhighlight lang="vb" line start="17">
 +
' Add a new button to our group
 +
With .Buttons.Add(New rxButton)
 +
    .Label = "My Button"                   
 +
End With
 +
</syntaxhighlight>
 +
 
 +
Each [[rxGroup]] object has a collection of [[rxButton]] objects (accesible through its ''buttons'' property). Here we add a new button to our group's buttons and label it 'My Button'
  
 
== Adding a handler for the button's onAction delegate ==
 
== Adding a handler for the button's onAction delegate ==
 +
At the moment the new button isn't of much use as it does nothing when clicked. In this section we will hook up to the control's onAction delegate.
  
 +
* Update the sub as follows
 +
<syntaxhighlight lang="vb" line highlight="21">
 +
Public Sub CreateMyUI3()
 +
   
 +
    Dim myCustomUI As rxCustomUI
 +
    Set myCustomUI = rxCustomUI.defaultInstance
 +
   
 +
    With myCustomUI
 +
        ' Clear old state
 +
        .Clear
 +
       
 +
        ' Add a new tab
 +
        With .ribbon.tabs.Add(New rxTab)
 +
            .Label = "My First Tab"
 +
            ' Add a new group to our tab
 +
            With .groups.Add(New rxGroup)
 +
                .Label = "My Group"
 +
               
 +
                ' Add a new button to our group
 +
                With .Buttons.Add(New rxButton)
 +
                    .Label = "My Button"
 +
                    ' Hook up the control's onAction delegate
 +
                    .onAction = myCustomUI.make_delegate("MyCallback")
 +
                End With
 +
               
 +
            End With
 +
        End With
 +
       
 +
        ' Render the UI
 +
        .Refresh
 +
    End With
 +
   
 +
End Sub
 +
</syntaxhighlight>
 +
* We have now hooked up the control's onAction delegate with a function called MyCallback, which we haven't yet provided.
 +
* We can now either manually provide a delegate stub function with the correct <u>name</u> and <u>signature</u>, or make use of the Ribbon Commander VBA tools to insert it automatically:
 +
*# Right-click inside the callback name string ("MyCallback" here)
 +
*# Follow the path 'Ribbon Commander'->'Insert Delegate Stubs'->'Insert [rxButton.onAction] stub':
 +
*#: [[image: InsertDelegateStub_ILYDA_UK.PNG|link=]]
 +
*# This will insert an empty stub right below the current function:
  
−
== Notes ==
+
<syntaxhighlight lang="vb">
 +
Sub MyCallback(ByVal control As RibbonCommander.IRibbonControl)
 +
    Err.Raise &H80004001, , "Not implemented"
 +
End Sub
 +
</syntaxhighlight>
 +
* Run the updated sub (CreateMyUI3).
 +
* The delegate stub currently raises and error. Update it to display a message box instead:
 +
<syntaxhighlight lang="vb">
 +
Sub MyCallback(ByVal control As RibbonCommander.IRibbonControl)
 +
    MsgBox "Hello, world!"
 +
End Sub
 +
</syntaxhighlight>
 +
* If everything has gone according to plan, clicking the button will now display:
 +
*: [[image: HelloWorldMsgBoxVBA.png|link=]]
 +
 
 +
== Code Analysis II ==
 +
<syntaxhighlight lang="vb" line start="17" highlight="5">
 +
' Add a new button to our group
 +
With .Buttons.Add(New rxButton)
 +
    .Label = "My Button"
 +
    ' Hook up the control's onAction delegate
 +
    .onAction = myCustomUI.make_delegate("MyCallback")
 +
End With
 +
</syntaxhighlight>
 +
 
 +
[[rxButton]] has a number of [[rxButton#Delegates|delegate properties]] which allow you to hook up callbacks to events of the control. One of them is onAction which is called when the button is clicked.
 +
 
 +
In the Ribbon Commander Framework, delegates are of type [[rxDelegate]] and are always associated with (and [[Method create|created]] via) a unique [[rxCustomUI]] instance.
 +
 
 +
Here, we create a new [[rxDelegate]] object for a VBA function named 'MyCallback' through our rxCustomUI's [[Method make_delegate | make_delegate]] method and connect the new object with our button (through its onAction property)
 +
 
 +
We can also write the snippet in a more verbose way:
 +
<syntaxhighlight lang="vb">
 +
' Add a new button to our group
 +
With .Buttons.Add(New rxButton)
 +
    .Label = "My Button"
 +
               
 +
    ' Create a new delegate for VBA function 'MyCallback'
 +
    Dim myDelegate As rxDelegate
 +
    Set myDelegate = myCustomUI.make_delegate("MyCallback")
 +
                                   
 +
    ' Hook up the control's onAction delegate
 +
    .OnAction = myDelegate
 +
End With
 +
</syntaxhighlight>
 +
 
 +
== Remarks ==
 +
 
 +
== Complete Example Code ==
 +
<syntaxhighlight lang="vb" line>
 +
Public Sub CreateMyUI3()
 +
   
 +
    Dim myCustomUI As rxCustomUI
 +
    Set myCustomUI = rxCustomUI.defaultInstance
 +
   
 +
    With myCustomUI
 +
        ' Clear old state
 +
        .Clear
 +
       
 +
        ' Add a new tab
 +
        With .ribbon.tabs.Add(New rxTab)
 +
            .Label = "My First Tab"
 +
            ' Add a new group to our tab
 +
            With .groups.Add(New rxGroup)
 +
                .Label = "My Group"
 +
               
 +
                ' Add a new button to our group
 +
                With .Buttons.Add(New rxButton)
 +
                    .Label = "My Button"
 +
                                       
 +
                    ' Hook up the control's onAction delegate
 +
                    .OnAction = myCustomUI.make_delegate("MyCallback")
 +
                End With
 +
               
 +
            End With
 +
        End With
 +
       
 +
        ' Render the UI
 +
        .Refresh
 +
    End With
 +
   
 +
End Sub
 +
 
 +
 
 +
Sub MyCallback(ByVal control As RibbonCommander.IRibbonControl)
 +
    MsgBox "Hello, world!"
 +
End Sub
 +
</syntaxhighlight>

Latest revision as of 11:04, 12 January 2015

Prerequisites

We recommend you go though A 'hello world' VBA program before going into this example.

Creating a button

  • Enter the code below in a standard VBA module
  1. Public Sub CreateMyUI3()
  2.  
  3.     Dim myCustomUI As rxCustomUI
  4.     Set myCustomUI = rxCustomUI.defaultInstance
  5.  
  6.     With myCustomUI
  7.         ' Clear old state
  8.         .Clear
  9.  
  10.         ' Add a new tab
  11.         With .ribbon.tabs.Add(New rxTab)
  12.             .Label = "My First Tab"
  13.             ' Add a new group to our tab
  14.             With .groups.Add(New rxGroup)
  15.                 .Label = "My Group"
  16.  
  17.                 ' Add a new button to our group
  18.                 With .Buttons.Add(New rxButton)
  19.                     .Label = "My Button"
  20.                 End With
  21.  
  22.             End With
  23.         End With
  24.  
  25.         ' Render the UI
  26.         .Refresh
  27.     End With
  28.  
  29. End Sub
  • Run the sub to create a button labeled 'My Button' (which belongs to a group labeled 'My Group' which, in turn' belongs to a tab labeled 'My Tab')
    FirstButton.png

Code Analysis I

  1. ' Add a new group to our tab
  2. With .groups.Add(New rxGroup)
  3.     .Label = "My Group"
  4.     '...
  5. End With

Each rxTab object has a collection of rxGroup objects (accessible through its groups property). Here we add a new group to our tab's groups and label it 'My Group' 


  1. ' Add a new button to our group
  2. With .Buttons.Add(New rxButton)
  3.     .Label = "My Button"                    
  4. End With

Each rxGroup object has a collection of rxButton objects (accesible through its buttons property). Here we add a new button to our group's buttons and label it 'My Button'

Adding a handler for the button's onAction delegate

At the moment the new button isn't of much use as it does nothing when clicked. In this section we will hook up to the control's onAction delegate.

  • Update the sub as follows
  1. Public Sub CreateMyUI3()
  2.  
  3.     Dim myCustomUI As rxCustomUI
  4.     Set myCustomUI = rxCustomUI.defaultInstance
  5.  
  6.     With myCustomUI
  7.         ' Clear old state
  8.         .Clear
  9.  
  10.         ' Add a new tab
  11.         With .ribbon.tabs.Add(New rxTab)
  12.             .Label = "My First Tab"
  13.             ' Add a new group to our tab
  14.             With .groups.Add(New rxGroup)
  15.                 .Label = "My Group"
  16.  
  17.                 ' Add a new button to our group
  18.                 With .Buttons.Add(New rxButton)
  19.                     .Label = "My Button"
  20.                     ' Hook up the control's onAction delegate
  21.                     .onAction = myCustomUI.make_delegate("MyCallback")
  22.                 End With
  23.  
  24.             End With
  25.         End With
  26.  
  27.         ' Render the UI
  28.         .Refresh
  29.     End With
  30.  
  31. End Sub
  • We have now hooked up the control's onAction delegate with a function called MyCallback, which we haven't yet provided.
  • We can now either manually provide a delegate stub function with the correct name and signature, or make use of the Ribbon Commander VBA tools to insert it automatically:
    1. Right-click inside the callback name string ("MyCallback" here)
    2. Follow the path 'Ribbon Commander'->'Insert Delegate Stubs'->'Insert [rxButton.onAction] stub':
      InsertDelegateStub ILYDA UK.PNG
    3. This will insert an empty stub right below the current function:
Sub MyCallback(ByVal control As RibbonCommander.IRibbonControl)
    Err.Raise &H80004001, , "Not implemented"
End Sub
  • Run the updated sub (CreateMyUI3).
  • The delegate stub currently raises and error. Update it to display a message box instead:
Sub MyCallback(ByVal control As RibbonCommander.IRibbonControl)
    MsgBox "Hello, world!"
End Sub
  • If everything has gone according to plan, clicking the button will now display:
    HelloWorldMsgBoxVBA.png

Code Analysis II

  1. ' Add a new button to our group
  2. With .Buttons.Add(New rxButton)
  3.     .Label = "My Button"
  4.     ' Hook up the control's onAction delegate
  5.     .onAction = myCustomUI.make_delegate("MyCallback")
  6. End With

rxButton has a number of delegate properties which allow you to hook up callbacks to events of the control. One of them is onAction which is called when the button is clicked.

In the Ribbon Commander Framework, delegates are of type rxDelegate and are always associated with (and created via) a unique rxCustomUI instance.

Here, we create a new rxDelegate object for a VBA function named 'MyCallback' through our rxCustomUI's make_delegate method and connect the new object with our button (through its onAction property)

We can also write the snippet in a more verbose way: 

' Add a new button to our group
With .Buttons.Add(New rxButton)
    .Label = "My Button"
 
    ' Create a new delegate for VBA function 'MyCallback'
    Dim myDelegate As rxDelegate
    Set myDelegate = myCustomUI.make_delegate("MyCallback")
 
    ' Hook up the control's onAction delegate
    .OnAction = myDelegate
End With

Remarks

Complete Example Code

  1. Public Sub CreateMyUI3()
  2.  
  3.     Dim myCustomUI As rxCustomUI
  4.     Set myCustomUI = rxCustomUI.defaultInstance
  5.  
  6.     With myCustomUI
  7.         ' Clear old state
  8.         .Clear
  9.  
  10.         ' Add a new tab
  11.         With .ribbon.tabs.Add(New rxTab)
  12.             .Label = "My First Tab"
  13.             ' Add a new group to our tab
  14.             With .groups.Add(New rxGroup)
  15.                 .Label = "My Group"
  16.  
  17.                 ' Add a new button to our group
  18.                 With .Buttons.Add(New rxButton)
  19.                     .Label = "My Button"
  20.  
  21.                     ' Hook up the control's onAction delegate
  22.                     .OnAction = myCustomUI.make_delegate("MyCallback")
  23.                 End With
  24.  
  25.             End With
  26.         End With
  27.  
  28.         ' Render the UI
  29.         .Refresh
  30.     End With
  31.  
  32. End Sub
  33.  
  34.  
  35. Sub MyCallback(ByVal control As RibbonCommander.IRibbonControl)
  36.     MsgBox "Hello, world!"
  37. End Sub
Retrieved from ‘https://documentation.ribboncommander.com/index.php?title=Creating_our_first_button_in_VBA&oldid=4161’