The RadioButtonGroup group can hold some ToggleButton ribbon items. ToggleButton can trigger an action or not as introduced before, so it can be associated with an external command class when necessary.
We demonstrated how to create RadioButtonGroup group and ToggleButton items of Revit Ribbon API before in C#. In this article, let us see how to do so in VB.NET.
It is always good to start with some succinct, cool, and still relatively complete code:
' Create two Ribbon Panels to host the same items and add one Panel to the 'AddIn' Ribbon Tab
' and the other to the custom 'RevitAddinWizard' Ribbon Tab if applicable in Revit 2012.
Function CreateRibbonPanel() As RibbonPanel
Dim prefix As String = "ABC" 'VendorId for example
Dim tabName1 As String = "AddIn"
Dim tabName2 As String = "RevitAddinWizard"
Dim panelTile As String = "Revit2012VBAddin"
Dim panelNameFormat As String = "{0}_{1}_{2}_{3}"
' This addes the new Ribbon Panel to the default native 'AddIn' Ribbon Tab in both Revit 2011 and 2012.
Dim panel As RibbonPanel = _cachedUiCtrApp.CreateRibbonPanel(Guid.NewGuid().ToString())
panel.Name = String.Format(panelNameFormat, prefix, tabName1, panelTile, 1) ' Unique and still possible to parse!
panel.Title = panelTile
AddRibbonItemsToRibbonPanel(panel)
' This addes the new Ribbon Panel to the custom 'RevitAddinWizard' Ribbon Tab in Revit 2012 only.
Try ' To avoid exceptions in case the same code is tried in Revit 2011
_cachedUiCtrApp.CreateRibbonTab(tabName2)
Dim panel1 As RibbonPanel = _cachedUiCtrApp.CreateRibbonPanel(tabName2, Guid.NewGuid().ToString())
panel1.Name = String.Format(panelNameFormat, prefix, tabName2, panelTile, 1) ' Unique and still possible to parse!
panel1.Title = panelTile
AddRibbonItemsToRibbonPanel(panel1)
Catch
End Try
Return panel
End Function
' Create RadioButtonGroup group and ToggleButton items
Public Sub AddRibbonItemsToRibbonPanel(ByVal panel As RibbonPanel)
Dim assemFullName As String = Assembly.GetExecutingAssembly.Location
Dim assemPath As String = Path.GetDirectoryName(assemFullName)
Dim cnt1Panel_grp1Data As RadioButtonGroupData = New RadioButtonGroupData("cnt1Panel_grp1")
Dim cnt1Panel_grp1 As RadioButtonGroup = CType(panel.AddItem(cnt1Panel_grp1Data), RadioButtonGroup)
Dim cnt1Panel_grp1_item1Data As ToggleButtonData = New ToggleButtonData("cnt1Panel_grp1_item1", "Option1", assemFullName, "RevitAddinCSProject.ExtCmd3")
Dim cnt1Panel_grp1_item1 As ToggleButton = cnt1Panel_grp1.AddItem(cnt1Panel_grp1_item1Data)
cnt1Panel_grp1_item1.ToolTip = "Option 1 of RadioButtonGroup"
cnt1Panel_grp1_item1.LargeImage = BmpImageSource("Revit2012VBAddin.BigC.bmp")
Dim cnt1Panel_grp1_item2Data As ToggleButtonData = New ToggleButtonData("cnt1Panel_grp1_item2", "Option2", assemFullName, "RevitAddinCSProject.ExtCmd4")
Dim cnt1Panel_grp1_item2 As ToggleButton = cnt1Panel_grp1.AddItem(cnt1Panel_grp1_item2Data)
cnt1Panel_grp1_item2.ToolTip = "Option 2 of RadioButtonGroup"
cnt1Panel_grp1_item2.LargeImage = BmpImageSource("Revit2012VBAddin.BigD.bmp")
End Sub
' Retrieve a Bitmap image resource
Public Shared Function BmpImageSource(ByVal embeddedPath As String) As System.Windows.Media.ImageSource
Dim stream As Stream = Assembly.GetExecutingAssembly().GetManifestResourceStream(embeddedPath)
Dim decoder = New System.Windows.Media.Imaging.BmpBitmapDecoder(stream, BitmapCreateOptions.PreservePixelFormat, BitmapCacheOption.Default)
Return decoder.Frames(0)
End Function
The RadioButtonGroup and ToggleButton creation is not hard to follow. We need to create the RadioButtonGroup container object first through creating a RadioButtonGroupData and adding a RadioButtonGroup object into a Ribbon Panel from the data object.
Then we can add any number of ToggleButton instances to the RadioButtonGroup that has been just created. The steps are pretty the same as adding ComboBoxMember items to ComboBox group, e.g. creating a data object ToggleButtonData first, adding a ToggleButton through calling the AddItem method against the RadioButtonGroup container next, and finally setting some other properties such as ToolTip and LargeImage.
The BmpImageSource() is a helper method that can be used by a Ribbon item to retrieve a specific bitmap image for its Image or LargeImage property if any from the Embedded Resources. It may be worth of mentioning the resource name here with a few words. In VB.NET, it is generally the project Default Namespace plus the image file name regardless whether the file is put into a project folder or not. However, in C#, things are different. We have to add the folder name if any in between.
The CreateRibbonPanel() is another helper method that will create Ribbon Panels and add them to the default native ‘AddIn’ (API name, the UI name is ‘Add-Ins’) Ribbon Tab and to our custom ‘RevitAddinWizard’ Ribbon Tab (the API name and the UI name are the same) respectively. It applies some good naming conventions and follows some good coding practices such as always feeding a GUID to the panel constructor and then setting its Name as easy to remember/parse and still unique and its Title as good for display which can be duplicate.
The AddIn (API name) or Add-Ins (UI name) Ribbon Tab may look like the following:
The RevitAddinWizard (both API and UI name) Ribbon Tab may look like this:
As can be seen, except for in different Ribbon Tabs, the Ribbon Panel, the RadioButtonGroup container and its ToggleButton items look and behave exactly the same.
Readers may wonder why Radio Button Group contains some Toggle Buttons here instead of naturally some Radio Buttons. There may be a few reasons. First, some concepts are confused obviously. Second, there is no such a thing as RadioButton in the Revit API. Third, the behavior of the RadioButtonGroup and ToggleButton might be just between radio buttons and toggle buttons, so neither can precisely describe it.
In fact, we have another article talking about these in detail:
Ribbon of Revit API – 4: RadioButtonGroup and ToggleButton
The RevitAddinWizard is going to provide the VB.NET version of the Ribbon Creator soon.
Recent Comments