Ribbon bar

In This Topic

Since 2022 version, Eplan GUI items are accessible by means of a ribbon. In API this control is represented by following classes :

Eplan.EplApi.Gui.RibbonBar
Eplan.EplApi.Gui.RibbonTab
Eplan.EplApi.Gui.RibbonCommandGroup
Eplan.EplApi.Gui.RibbonCommand

The ribbon is divided on tabs and these on command groups and commands.

All ribbon related classes are stored in Eplan.EplApi.Gui namespace. They correspond with types of ribbon items from GUI :

Here is an example of listing ribbon items (tabs, command groups and commands):

RibbonBar ribbonBar = new RibbonBar();
foreach (RibbonTab tab in ribbonBar.Tabs)
{
    Debug.WriteLine($"\tTab Name:{tab.Name}------------");
    foreach (var commandGroup in tab.CommandGroups)
    {
        Debug.WriteLine($"\t\tCommand group:{commandGroup.Name}------");
        foreach (var command in commandGroup.Commands)
        {
            RibbonCommand ribbonCommand = command.Value;
            uint commandId          = ribbonCommand.ID;
            string strText          = ribbonCommand.Text;
            string strDescription   = ribbonCommand.Description;
            string strTooltipText   = ribbonCommand.TooltipText;
            string strActionCommandLine = ribbonCommand.ActionCommandLine;
            Debug.WriteLine($"\t\t\tCommand Id:{commandId}---.Text:{strText}---.ActionCommandLine:{strActionCommandLine}---.TooltipText:{strTooltipText}---.Description:{strDescription}");
        }
        Debug.WriteLine($"\t\t-----------------------");
    }
    Debug.WriteLine($"\t-----------------------------");
}

Please mind that some tabs are context sensitive, i.e they are open only when editor is visible.

Old menu and toolbars are no longer accessible. The equivalent of old menu point/toolbar button is now ribbon command :

In API, commands can be created in following places:

"Extensions"->"API" command group
A custom command group that is placed in a persistient or custom tab

Migration from menu and toobar

The classes corresponding to old GUI items i.e. Toolbar and Menu are currently deprecated, so it is highly recommended to migrate relevant code.

Following table shows how to create new ribbon items together with example code:

Old GUI item	Old API method	New GUI equivalent	New API method	Example old code	Example new code
Main menu	Menu.AddMainMenu	RibbonTab	RibbonBar.AddTab	menu.AddMainMenu("API Tests A-N", Menu.MainMenuName.eMainMenuHelp,"AddingMessageAction", "AddingMessageAction", "First menu element", 1);	var ribbonTab = ribbonBar.AddTab("API Tests A-N");
Popup menu	Menu.AddPopupMenuItem	RibbonCommandGroup	RibbonTab.AddCommandGroup	menu.AddPopupMenuItem("ActionExample - test2","ActionExample - test2 submenupoint1", "ActionExample", "status text", mainID, 0, false, false);	var commandGroup = ribbonTab.AddCommandGroup("ActionExample - test2");
Toolbar	toolbar.CreateCustomToolbar	RibbonCommandGroup	RibbonTab.AddCommandGroup	toolbar.CreateCustomToolbar("SelectionSet", Toolbar.ToolBarDockPos.eToolbarLeft, 4, 1, true);	var commandGroup = ribbonTab.AddCommandGroup("SelectionSet");
Menu item	menu.AddMenuItem(	RibbonCommand	RibbonBar.AddCommand , RibbonCommandGroup.AddCommand	menu.AddMenuItem("UndoAction", "UndoAction"); menu.AddMenuItem("SelectionRecursive", "SelectionRecursiveAction", "", selectionSetID, 1,false, false);	ribbonBar.AddCommand("UndoAction", "UndoAction"); commandGroup.AddCommand("SelectionRecursive", "SelectionRecursiveAction");
Toolbar button	toolbar.AddButton(	RibbonCommand	RibbonCommandGroup.AddCommand(…,index)	toolbar.AddButton("SelectionSet", Int32.MaxValue, "SelectionOneItemAction","C:\\myicons\\0.ico", "SelectionOneItemAction");	commandGroup.AddCommand("SelectionOneItemAction", "SelectionOneItemAction", 0);

Here is also a list of other old methods and their new conterparts :

Old method	New method

Toolbar.ExistsToolbar	RibbonBar.Tabs.Any(by LINQ) RibbonBar.GetTab RibbonBar.GetDefaultTab
Toolbar.GetButtonAction	RibbonCommand.ActionCommandLine
Toolbar.GetButtonToolTip	RibbonCommand.TooltipText
Toolbar.GetCountOfButtons	RibbonCommandGroup.Commands.Count
Toolbar.GetPersistentButtonId Menu.GetCustomMenuId GetPersistentMenuId	RibbonCommand.ID
Toolbar.RemoveButton	RibbonCommand.Remove
Toolbar.RemoveCustomToolbar	RibbonCommandGroup.Remove
Menu.IsActionChecked	RibbonCommand.IsChecked
Menu.IsActionEnabled	RibbonCommand.IsEnabled
Menu.RemoveMenuItem	RibbonTab.Remove RibbonCommandGroup.Remove RibbonCommand.Remove

ContextMenu class is not affected by this change, i.e everything should work as before 2022 version.

For more information, please refer to chapter "The New Ribbon" of Eplan Help.

Scripts

Adding ribbon items by a script

Addins

Adding ribbon commands

Send Feedback