Difference between revisions of "Using XML in VBA"

From Ribbon Commander Documentation
Jump to: navigation, search
Line 51: Line 51:
  
 
== A more complete example ==
 
== A more complete example ==
 +
<syntaxhighlight lang="vb" line>
 +
Public Sub CompleteExample()
 +
   
 +
    ' Create a new rxCustomUI
 +
    Dim myCustomUI As rxCustomUI
 +
    Set myCustomUI = rxCustomUI.Create("my_test_context")
 +
   
 +
    With myCustomUI
 +
        With .ribbon.tabs.Add(New rxTab)
 +
            .Label = "My Tab"
 +
            .Visible = rxTrue
 +
            With .groups.Add(New rxGroup)
 +
                .Label = "Group 1"
 +
                With .Buttons.Add(New rxButton)
 +
                    .Label = "Button1"
 +
                    .OnAction = myCustomUI.make_delegate("Callback1")
 +
                End With
 +
                With .Buttons.Add(New rxButton)
 +
                    .Label = "Button2"
 +
                    .getEnabled = myCustomUI.make_delegate("Callback2")
 +
                End With
 +
            End With
 +
            With .groups.Add(New rxGroup)
 +
                .Label = "Group 2"
 +
                With .Buttons.Add(New rxButton)
 +
                    .Label = "Button3"
 +
                    .getKeytip = myCustomUI.make_delegate("Callback3")
 +
                End With
 +
                With .Buttons.Add(New rxButton)
 +
                    .Label = "Button4"
 +
                    .getShowImage = myCustomUI.make_delegate("Callback4")
 +
                    .ID = "button4"
 +
                End With
 +
            End With
 +
           
 +
        End With
 +
       
 +
        ' Cache the xml state of 'myCustomUI' and print it out in the debug window
 +
        Dim sXml As String
 +
        sXml = .SerializeToXML
 +
       
 +
        Debug.Print sXml
 +
       
 +
    End With
 +
   
 +
End Sub
 +
</syntaxhighlight>
  
 
<syntaxhighlight lang="xml">
 
<syntaxhighlight lang="xml">

Revision as of 23:15, 14 March 2013

Introduction

Dynamic RibbonX controls are both

  • Serializable to XML
  • Instantiatable from XML

Serializing to XML

Public Sub SerializingButton()
 
    ' Create a new button
    Dim myButton As rxButton
    Set myButton = New rxButton
 
    ' Build up state
    With myButton
        .label = "My Button"
        .enabled = rxTrue
        .supertip = "My button supertip"
 
        ' Serialize to XML
        Debug.Print .XML
    End With
 
End Sub

The VBA code above prints out the following XML code to the debug window: 

<button supertip="My button supertip" enabled="true" label="My Button"></button>

Instantiating from XML

  1. Public Sub InstantiateButtonFromXML()
  2.  
  3.     ' Create a new button
  4.     Dim myButton As rxButton
  5.     Set myButton = New rxButton
  6.  
  7.     myButton.readXml "<button supertip=""My button supertip"" enabled=""true"" label=""My Button""/>"
  8.  
  9.     Debug.Print "supertip=[" & myButton.supertip & "], " & _
  10.                 "enabled=[" & (myButton.Enabled = rxTrue) & "], " & _
  11.                 "label=[" & myButton.Label & "]"
  12.  
  13. End Sub

The VBA code above prints out the following XML code to the debug window: 

supertip=[My button supertip], enabled=[True], label=[My Button]

A more complete example

  1. Public Sub CompleteExample()
  2.  
  3.     ' Create a new rxCustomUI
  4.     Dim myCustomUI As rxCustomUI
  5.     Set myCustomUI = rxCustomUI.Create("my_test_context")
  6.  
  7.     With myCustomUI
  8.         With .ribbon.tabs.Add(New rxTab)
  9.             .Label = "My Tab"
  10.             .Visible = rxTrue
  11.             With .groups.Add(New rxGroup)
  12.                 .Label = "Group 1"
  13.                 With .Buttons.Add(New rxButton)
  14.                     .Label = "Button1"
  15.                     .OnAction = myCustomUI.make_delegate("Callback1")
  16.                 End With
  17.                 With .Buttons.Add(New rxButton)
  18.                     .Label = "Button2"
  19.                     .getEnabled = myCustomUI.make_delegate("Callback2")
  20.                 End With
  21.             End With
  22.             With .groups.Add(New rxGroup)
  23.                 .Label = "Group 2"
  24.                 With .Buttons.Add(New rxButton)
  25.                     .Label = "Button3"
  26.                     .getKeytip = myCustomUI.make_delegate("Callback3")
  27.                 End With
  28.                 With .Buttons.Add(New rxButton)
  29.                     .Label = "Button4"
  30.                     .getShowImage = myCustomUI.make_delegate("Callback4")
  31.                     .ID = "button4"
  32.                 End With
  33.             End With
  34.  
  35.         End With
  36.  
  37.         ' Cache the xml state of 'myCustomUI' and print it out in the debug window
  38.         Dim sXml As String
  39.         sXml = .SerializeToXML
  40.  
  41.         Debug.Print sXml
  42.  
  43.     End With
  44.  
  45. End Sub
<customUI xmlns="http://schemas.microsoft.com/office/2009/07/customui">
  <ribbon>
    <tabs>
      <tab id="RX4C5E51-2222-4D76-AEF5-97D7460E8FC9" visible="true" label="My Tab">
        <group id="RX4F6096-0B31-42F9-B299-823510E5C304" label="Group 1">
          <button label="Button1" id="RXE10CA5-9197-4FF7-A7BA-5ECEB4DF6D6C" onAction="Callback1"></button>
          <button label="Button2" id="RXE269D3-0CB2-4031-90D2-E91304BC5D8F" getEnabled="Callback2"></button>
        </group>
        <group id="RX6A4144-9F73-4307-8F26-B2B107764E08" label="Group 2">
          <button label="Button3" id="RX8480FB-8F17-4489-AA16-76C4178826EC" getKeytip="Callback3"></button>
          <button label="Button4" id="button4" getShowImage="Callback4"></button>
        </group>
      </tab>
    </tabs>
  </ribbon>
</customUI>
Retrieved from ‘https://documentation.ribboncommander.com/index.php?title=Using_XML_in_VBA&oldid=2015’