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

From Ribbon Commander Documentation
Jump to: navigation, search
Line 34: Line 34:
  
 
== Code Analysis ==
 
== Code Analysis ==
 +
<syntaxhighlight lang="vb">
 +
' 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">
 +
' 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 out 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 ==

Revision as of 18:14, 10 March 2013

Prerequisites

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

Creating a button

  1. Public Sub CreateMyUI()
  2.  
  3.     With rxCustomUI.defaultInstance
  4.         ' Clear old state
  5.         .Clear
  6.  
  7.         ' Add a new tab
  8.         With .ribbon.tabs.Add(New rxTab)
  9.             .Label = "My First Tab"
  10.             ' Add a new group to our tab
  11.             With .groups.Add(New rxGroup)
  12.                 .Label = "My Group"
  13.  
  14.                 ' Add a new button to our group
  15.                 With .Buttons.Add(New rxButton)
  16.                     .Label = "My Button"
  17.  
  18.                 End With
  19.  
  20.             End With
  21.         End With
  22.  
  23.         ' Render the UI
  24.         .Refresh
  25.     End With
  26.  
  27. End Sub

Code Analysis

' Add a new group to our tab
With .groups.Add(New rxGroup)
    .Label = "My Group"
    '...
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' 


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

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


Adding a handler for the button's onAction delegate

Notes

Retrieved from ‘https://documentation.ribboncommander.com/index.php?title=Creating_our_first_button_in_VBA&oldid=256’