一个插件可以向“扩展 > API命令”组添加一个或多个功能区命令。因此,类 Eplan.EplApi.Gui.RibbonBar
提供了一个函数 AddCommand
,该函数应在插件类的 OnRegister()
方法中调用:
/// <summary>
/// The function is called once during registration add-in.
/// </summary>
/// <param name="bLoadOnStart"> true: In the next Eplan session, add-in will be loaded during initialization</param>
/// <returns></returns>
public bool OnRegister(ref System.Boolean bLoadOnStart)
{
var ribbonBar= new Eplan.EplApi.Gui.RibbonBar();
ribbonBar.AddCommand("CSharpAction", "CSharpAction");
return true;
}
/// <summary>
/// The function is called during unregistration the add-in.
/// </summary>
/// <returns></returns>
public bool OnUnregister()
{
var ribbonBar = new Eplan.EplApi.Gui.RibbonBar();
return ribbonBar.RemoveCommand("CSharpAction");
}
函数 AddCommand(text, command line)
会添加一个带有文本 "CSharpAction
" 的按钮(即功能区命令),并将动作 "CSharpAction
" 分配给该按钮。该按钮随后会显示在“扩展 > API命令”组中。也可以将其添加到一个持久存在的或自定义选项卡中的自定义命令组。
功能区命令始终分配给一个动作。这可以是一个自定义动作(使用API创建)或一个已经存在的动作。
脚本文件的位置可以是绝对路径,也可以是相对路径。相对路径是从附加组件路径(BIN文件夹和CFG文件夹所在的位置)计算的。