Ribbon Creator – 2: TextBox - RevitNetAddinWizard & NavisworksNetAddinWizard

Let’s see how to create TextBox items using RevitAddinWizard.

After the menu item or the tool of the Revit Addin Coder is clicked, the Ribbon Creator window will appear. Then a TextBox can be specified in the Item column and Text/Tooltip can be input for the TextBox. A default image is provided for each TextBox as shown in the first TextBox in the following screenshot and the image can be changed to any other one through clicking on the icon itself as shown in the second TextBox. A Separator is also demonstrated in this example:

As can be noticed, the Command cells are all disabled for these TextBox and Separator items as they do not trigger any commands.

After the OK button is pressed, the following code will be created:

        public void AddRibbonItemsToRibbonPanel(RibbonPanel panel)
        {
            string assemFullName = Assembly.GetExecutingAssembly().Location;
            string assemPath = Path.GetDirectoryName(assemFullName);

            TextBoxData cnt1Panel_grp0_item1Data = new TextBoxData("cnt1Panel_grp0_item1");
            Autodesk.Revit.UI.TextBox cnt1Panel_grp0_item1 = panel.AddItem(cnt1Panel_grp0_item1Data) as Autodesk.Revit.UI.TextBox;
            cnt1Panel_grp0_item1.ToolTip = @"How are you?";
            cnt1Panel_grp0_item1.Value = @"Hello";
            cnt1Panel_grp0_item1.Image = BmpImageSource(@"RevitAddinCSProject.Resources.CheckAndUpdate.bmp");
            cnt1Panel_grp0_item1.ShowImageAsButton = true;
            cnt1Panel_grp0_item1.EnterPressed += CallbackOfTextBoxEnterPressed;

            panel.AddSeparator();

            TextBoxData cnt1Panel_grp0_item3Data = new TextBoxData("cnt1Panel_grp0_item3");
            Autodesk.Revit.UI.TextBox cnt1Panel_grp0_item3 = panel.AddItem(cnt1Panel_grp0_item3Data) as Autodesk.Revit.UI.TextBox;
            cnt1Panel_grp0_item3.ToolTip = @"How's it going?";
            cnt1Panel_grp0_item3.Value = @"Hey";
            cnt1Panel_grp0_item3.Image = BmpImageSource(@"RevitAddinCSProject.Resources.good.bmp");
            cnt1Panel_grp0_item3.ShowImageAsButton = true;
            cnt1Panel_grp0_item3.EnterPressed += CallbackOfTextBoxEnterPressed;

        }

public static void CallbackOfTextBoxEnterPressed(object sender, TextBoxEnterPressedEventArgs args)
{

}

        public static System.Windows.Media.ImageSource BmpImageSource(string embeddedPath)
        {
            Stream stream = Assembly.GetExecutingAssembly().GetManifestResourceStream(embeddedPath);
            var decoder = new System.Windows.Media.Imaging.BmpBitmapDecoder(stream, BitmapCreateOptions.PreservePixelFormat, BitmapCacheOption.Default);
            return decoder.Frames[0];
        }

As shown in the code, each TextBox is associated with an image and clicking the image will trigger an event to update the value of the text box from its current input; otherwise the ENTER key has to be pressed so as to update the value. If not, the input will just be lost as introduced in early posts.

If some extra code is added to the same External Application:

                RibbonPanel panel = _cachedUiCtrApp.CreateRibbonPanel(Guid.NewGuid().ToString());
                AddRibbonItemsToRibbonPanel(panel);
                panel.Name = "ABC_APP3_PNL2";
                panel.Title = "Buttons created by the RevitAddinWizard";

something like the following will be added to the Revit Ribbon (depending on what the specified image really looks like):

As can be seen, the left text box has the default image and the right one has a different one specified in the Ribbon Creator window, and they function the same through the handler of the event EnterPressed of the TextBox.