概述

RobotStudio软件除了自身具备的强大功能以外，还支持安装功能插件（Add-Ins），ABB机器人厂商为用户提供了部分功能完备的插件，如机加工插件、喷涂插件、码垛插件、高速拾取插件等。

对于有特殊需求的用户，RobotStudio软件还支持插件的二次开发。为了使用户能够更加方便的使用二次开发的插件，RobotStudio SDK中提供了用于插件UI二次开发的接口函数，使用这些接口函数开发人员能够开发出与RobotStudio软件类似的交互界面，给用户更加友好的交互体验。

插件UI的二次开发有两种方法，一种是基于xml文件的界面开发，另一种是直接使用C#语言进行界面开发。本期就来为大家介绍一下，使用C#语言对RobotStudio软件插件UI的二次开发方法。

Robotstudio软件版本：RobotStudio 6.08

SDK版本：RobotStudio SDK.6.08

开发软件版本：Microsoft Visual Studio Professional 2019

项目创建与配置

使用ABB机器人厂商提供的RobotStudio软件二次开发模板“RobotStudio 6.08 Empty Add-in”创建基于C#语言的RobotStudio软件插件二次开发项目。

在使用RobotStudio软件二次开发模板之前首先要搭建二次开发环境，详细过程请参考已发布过的文章《基于C#语言的RobotStudio软件二次开发基础》。

项目创建完成后默认已经打开，并且添加了用于插件二次开发的部分引用。由于开发的插件界面按钮会有图标选项，因此需要单独为项目添加引用System.Drawing。依次点击“项目”→“添加引用”，在引用管理器的“程序集”中选择“System.Drawing”即可。

注：若是二次开发的界面中不添加任何与图片相关的图标，则不需要添加引用System.Drawing。

插件UI结构与开发流程

二次开发的插件UI与RobotStudio软件的交互界面结构是一致的，RobotStudio软件的交互界面包含菜单（也被称为功能选项卡），在菜单下包含多个功能区，功能区中又包含若干个功能按钮。

二次开发出的插件的UI也包含这些结构要素，并且在开发过程中遵循由大类要素向小类要素依次开发的流程，即先在插件中编写菜单程序，然后是编写创建功能区程序，再在功能区中编写创建按钮程序，最后为创建的每一个按钮编写相应事件处理程序。

菜单栏创建

插件菜单栏可以使用public RibbonTab(string id,string caption)接口函数创建，其中id是菜单栏的唯一识别标识，caption为菜单栏的标题名称，二者均为字符串类型。创建菜单栏的程序代码如下所示。

//创建菜单
RibbonTab ribbonTab = new RibbonTab("ribbonTab", "自定义菜单");
//将创建的菜单添加到RobotStudio软件的菜单栏中
UIEnvironment.RibbonTabs.Add(ribbonTab);
//将菜单设为激活
UIEnvironment.ActiveRibbonTab = ribbonTab;

功能区创建

使用public RibbonGroup(string id,string caption)接口函数创建插件功能区，其中id是功能区的唯一识别标识，caption为功能区的标题名称，二者均为字符串类型。创建功能区的程序代码如下所示。

//创建功能区1
RibbonGroup ribbonGroup1 = new RibbonGroup("ribbonGroup1", "功能区1");
//功能区添加到菜单下
ribbonTab.Groups.Add(ribbonGroup1);

按钮创建

插件中的按钮有多种类型可供选择，不同类型的按钮具备不同的功能，如普通按钮、下拉菜单按钮、选项按钮、自定义按钮等，本例以创建普通按钮为例。

使用public CommandBarButton(string id,string caption)接口函数可以在插件中创建普通按钮，其中id是按钮的唯一识别标识，caption为按钮的名称，二者均为字符串类型。创建按钮的程序代码如下所示。

//在功能区1创建按钮1
CommandBarButton commandBarButton1=new CommandBarButton("commandBarButton1", "按钮1");
commandBarButton1.HelpText = "按钮1帮助说明";
//设置按钮1图标
commandBarButton1.Image = Image.FromFile("E:\\ABB C\\RobotStudioEmptyAddin2\\RobotStudioEmptyAddin2\\Image\\RobotStudioSampleAddin1.Button1.Large.png");
commandBarButton1.DefaultEnabled = true;
//按钮1添加到功能区1
ribbonGroup1.Controls.Add(commandBarButton1);

按钮的尺寸大小可以使用public enum RibbonControlLayout接口函数语句设置，程序代码如下所示。

//设置按钮大小，按钮1设置为小按钮
RibbonControlLayout[] ribbonControlLayout = { RibbonControlLayout.Small, RibbonControlLayout.Large,RibbonControlLayout.Small};
ribbonGroup1.SetControlLayout(commandBarButton1, ribbonControlLayout[0]);

按钮事件处理程序编写

按钮事件处理程序包含两个部分，一、按钮UI刷新事件处理程序，可以使用public sealed class UpdateCommandUIEventArgs : EventArgs接口函数实现；二、按钮响应事件处理程序，可以使用public sealed class ExecuteCommandEventArgs : EventArgs接口函数实现。按钮事件处理的初始化程序代码如下所示。

//添加按钮1的UI刷新处理程序
commandBarButton1.UpdateCommandUI += new UpdateCommandUIEventHandler(button1_UpdateCommandUI);
//添加按钮1的响应事件处理程序
commandBarButton1.ExecuteCommand += new ExecuteCommandEventHandler(button1_ExecuteCommand);

完整程序代码

按照RobotStudio软件插件二次开发流程对插件UI进行二次开发，示例中分别创建一个菜单，在菜单中添加两个功能区，其中功能区1中创建两个按钮，功能区2中创建一个按钮，对三个按钮点击后在RobotStudio软件的信息输出界面中分别输出相应的信息提示。完整的程序代码如下所示。

using System;
using System.Collections.Generic;
using System.Text;
using System.Drawing;

using ABB.Robotics.Math;
using ABB.Robotics.RobotStudio;
using ABB.Robotics.RobotStudio.Environment;
using ABB.Robotics.RobotStudio.Stations;

namespace RobotStudioEmptyAddin2
{
    public class Class1
    {
        // This is the entry point which will be called when the Add-in is loaded
        public static void AddinMain()
        {
            //Begin UndoStep
            Project.UndoContext.BeginUndoStep("RobotStudioEmptyAddin");

            try
            {
                //创建菜单
                RibbonTab ribbonTab = new RibbonTab("ribbonTab", "自定义菜单");
                //将创建的菜单添加到RobotStudio软件的菜单栏中
                UIEnvironment.RibbonTabs.Add(ribbonTab);
                //将菜单设为激活
                UIEnvironment.ActiveRibbonTab = ribbonTab;

                //创建功能区1与功能区2
                RibbonGroup ribbonGroup1 = new RibbonGroup("ribbonGroup1", "功能区1");
                RibbonGroup ribbonGroup2 = new RibbonGroup("ribbonGroup2", "功能区2");
                //功能区添加到菜单下
                ribbonTab.Groups.Add(ribbonGroup1);
                ribbonTab.Groups.Add(ribbonGroup2);

                //在功能区1创建按钮1
                CommandBarButton commandBarButton1=new CommandBarButton("commandBarButton1", "按钮1");
                commandBarButton1.HelpText = "按钮1帮助说明";
                //设置按钮1图标
                commandBarButton1.Image = Image.FromFile("E:\\ABB C\\RobotStudioEmptyAddin2\\RobotStudioEmptyAddin2\\Image\\RobotStudioSampleAddin1.Button1.Large.png");
                commandBarButton1.DefaultEnabled = true;
                //按钮1添加到功能区1
                ribbonGroup1.Controls.Add(commandBarButton1);

                //功能区1按钮之间创建分隔符
                CommandBarSeparator commandBarSeparator = new CommandBarSeparator();
                ribbonGroup1.Controls.Add(commandBarSeparator);

                //在功能区1创建按钮2
                CommandBarButton commandBarButton2 = new CommandBarButton("commandBarButton2", "按钮2");
                commandBarButton2.HelpText = "按钮2帮助说明";
                //设置按钮2图标
                commandBarButton2.Image = Image.FromFile("E:\\ABB C\\RobotStudioEmptyAddin2\\RobotStudioEmptyAddin2\\Image\\RobotStudioSampleAddin1.Button2.Large.png");
                commandBarButton2.DefaultEnabled = true;
                //按钮2添加到功能区1
                ribbonGroup1.Controls.Add(commandBarButton2);

                //在功能区2创建按钮3
                CommandBarButton commandBarButton3 = new CommandBarButton("commandBarButton3", "按钮3");
                commandBarButton3.HelpText = "按钮3帮助说明";
                //设置按钮3图标
                commandBarButton3.Image = Image.FromFile("E:\\ABB C\\RobotStudioEmptyAddin2\\RobotStudioEmptyAddin2\\Image\\RobotStudioSampleAddin1.CloseButton.Large.png");
                commandBarButton3.DefaultEnabled = true;
                //按钮3添加到功能区2
                ribbonGroup2.Controls.Add(commandBarButton3);

                //设置按钮大小，按钮1设置为小按钮，按钮2设置为大按钮，按钮3为小按钮
                RibbonControlLayout[] ribbonControlLayout = { RibbonControlLayout.Small, RibbonControlLayout.Large,RibbonControlLayout.Small};
                ribbonGroup1.SetControlLayout(commandBarButton1, ribbonControlLayout[0]);
                ribbonGroup1.SetControlLayout(commandBarButton2, ribbonControlLayout[1]);
                ribbonGroup2.SetControlLayout(commandBarButton3, ribbonControlLayout[2]);

                //添加按钮1的UI刷新处理程序
                commandBarButton1.UpdateCommandUI += new UpdateCommandUIEventHandler(button1_UpdateCommandUI);
                //添加按钮1的响应事件处理程序
                commandBarButton1.ExecuteCommand += new ExecuteCommandEventHandler(button1_ExecuteCommand);

                commandBarButton2.UpdateCommandUI += new UpdateCommandUIEventHandler(button2_UpdateCommandUI);
                commandBarButton2.ExecuteCommand += new ExecuteCommandEventHandler(button2_ExecuteCommand);

                commandBarButton3.UpdateCommandUI += new UpdateCommandUIEventHandler(button3_UpdateCommandUI);
                commandBarButton3.ExecuteCommand += new ExecuteCommandEventHandler(button3_ExecuteCommand);
            }
            catch (Exception ex)
            {
                Project.UndoContext.CancelUndoStep(CancelUndoStepType.Rollback);
                Logger.AddMessage(new LogMessage(ex.Message.ToString()));
            }
            finally
            {
                Project.UndoContext.EndUndoStep();
            }
        }
        static void button1_UpdateCommandUI(object sender, UpdateCommandUIEventArgs e)
        {
            //按钮1被激活，用来取代程序语句button1.Enabled = true
            e.Enabled = true;
        }

        static void button1_ExecuteCommand(object sender, ExecuteCommandEventArgs e)
        {
            //按钮1被按下输出信息提示
            Logger.AddMessage(new LogMessage("按下按钮1。"));
        }
        static void button2_UpdateCommandUI(object sender, UpdateCommandUIEventArgs e)
        {
            e.Enabled = true;
        }

        static void button2_ExecuteCommand(object sender, ExecuteCommandEventArgs e)
        {
            Logger.AddMessage(new LogMessage("按下按钮2。"));
        }
        static void button3_UpdateCommandUI(object sender, UpdateCommandUIEventArgs e)
        {
            e.Enabled = true;
        }

        static void button3_ExecuteCommand(object sender, ExecuteCommandEventArgs e)
        {
            Logger.AddMessage(new LogMessage("按下按钮3。"));
        }
    }
}

运行测试

首先将准备好的按钮图标文件保存到按钮图标设置程序语句指定的文件目录中，然后对项目进行编译。

编译成功后在项目文件目录的Debug文件夹下可以看到RobotStudioEmptyAddin2.dll与RobotStudioEmptyAddin2.rsaddin两个文件。

将Debug文件夹下编译生成的两个插件文件复制到X:\Program Files (x86)\ABB Industrial IT\Robotics IT\RobotStudio 6.08\Bin\Addins文件目录中。（X为Robotstudio软件安装盘盘符）

打开RobotStudio软件，将开发的插件加载进来。可以看到软件中新创建了插件菜单，插件菜单中包含添加的功能区以及按钮。对按钮分别进行点击，软件下方的信息输出界面中分别输出对应的提示信息。运行测试效果如下方动态图所示。

The End

上一篇：基于C#语言的Robotstudio软件二次开发基础