View source for Creating an rxCustomUI object with global dispatch scope in VBA

== Prerequisites ==
We recommend you go through [[Creating our first button in VBA]] before getting into this example.

== Background ==
{{Context Intro Background}}

== Creating a new global context with a check box ==
* Enter the code below in a standard module
<syntaxhighlight lang="vb" line>
Public Sub GlobalContextUI()
    
    ' Create an rxCustomUI in a global context
    Dim myCustomUI As rxCustomUI
    Set myCustomUI = rxCustomUI.create("my_sample_context", "My Global Context", DispatchScope_global)
    
    With myCustomUI
        .Clear
    
        With .ribbon.tabs.Add(New rxTab)
            .Label = "Global Ctx Tab"
            With .groups.Add(New rxGroup)
                .Label = "Global Ctx Group"
                With .CheckBoxes.Add(New rxCheckBox)
                    .Label = "Global Ctx Checkbox"
                    .OnAction = myCustomUI.make_delegate("MyGlobalCtxCheckBoxCallback")
                End With
            End With
        End With
        
        .Refresh
    End With
    
End Sub

Sub MyGlobalCtxCheckBoxCallback(ByVal control As RibbonCommander.IRibbonControl, pressed As Boolean)
    MsgBox "Global Ctx Checkbox " & IIf(pressed, "clicked", "un-clicked")
End Sub
</syntaxhighlight>
* Run sub '''GlobalContextUI''' to create a new check box labeled ''Global Ctx Checkbox'' in its own global context.
[[image: GlobalCtxCheckBox.png|link=]]
* If everything has gone according to plan, the following message box will appear:
[[image: GlobalCtxMsgBox.png|link=]]

== Code Analysis ==
The above code should be pretty much familiar (see [[Creating our first button in VBA]], instead of a button we are using a check box in this example) apart from the lines below:
<syntaxhighlight lang="vb" line start="3">
' Create an rxCustomUI in a global context
Dim myCustomUI As rxCustomUI
Set myCustomUI = rxCustomUI.create("my_sample_context", "My Global Context", DispatchScope_global)
</syntaxhighlight>

Here we create a new [[rxCustomUI]] with [[rxDispatchScope|global dispatch scope]] through [[rxCustomUI]]'s static function [[Method create|create]] with the following arguments:
* ''contextId'' == "my_sample_context". An id string that uniquely identifies this context. Other add-ins/applications can access this same context by creating a context with the same id.
* ''description'' == "My Global Context". This is the context's description. It appears when a user hovers over one of the context's controls:
*: [[image:GlobalCtxAddinDescription.png|link=]]
* dispatchScope == DispatchScope_global. Global dispatch scope