RibbonBar Class

In This Topic

Represents ribbon bar control.

Inheritance Hierarchy

System.Object
Eplan.EplApi.Gui.RibbonBar

Syntax

C#
C++/CLI

public class RibbonBar

public ref class RibbonBar

Remarks

The RibbonBar represents the whole ribbon bar control. All elements belonging to it are accessible through RibbonBar class. They are represented by classes RibbonTab, RibbonCommandGroup and RibbonCommand. For more information, please refer to "Ribbon bar" chapter of API Help or "The New Ribbon" chapter of Eplan Platform Help.

Example

Example below shows how to avoid GUI flickering and make sure that RibbonBar will be refreshed just after the add operations are completed. Parameter refreshAfterChanges=true means that refresh will be executed only once on RibbonBar destructor, in this case at the end of using() statement. This technique can be used also for removing elements from RibbonBar.

using (var ribbonBar = new RibbonBar(true))
{
    var ribbonTab = ribbonBar.AddTab("MyTab1") ?? ribbonBar.GetTab("MyTab1");
    var commandGroup = ribbonTab.AddCommandGroup("MyExampleActions");
    commandGroup.AddCommand("MyExampleAction1", "ExampleAction /PARAM:1");
    commandGroup.AddCommand("MyExampleAction2", "ExampleAction /PARAM:2");
    commandGroup.AddCommand("MyExampleAction3", "ExampleAction /PARAM:3");
}

Example of adding a command to the last position of the ribbon

RibbonBar ribbonBar = new RibbonBar();
ribbonBar.AddCommand("New ribbon button text", "XPartsManagementStart", new RibbonIcon(CommandIcon.Circle_0));

Example of adding a tab, command group and a command

var newTab = new Eplan.EplApi.Gui.RibbonBar().AddTab("New API tab");
var commandGroup = newTab.AddCommandGroup("New API command group");
var command = commandGroup.AddCommand("New API command", "XPartsManagementStart");

Public Constructors

	Name	Description
	RibbonBar Constructor	Overloaded.

Top

Public Properties

	Name	Description
	ActiveTab	Returns active tab
	Icons	Returns icons of the ribbon bar
	Tabs	Returns tabs of the ribbon bar

Top

Public Methods

	Name	Description
	AddCommand	Overloaded. Adds command to the ribbon
	AddDelayedAction	Calls an action object on the ribbon. If the ribbon doesn't exist yet, the action will be executed after the system start is finished
	AddIcon	Adds new icon to the ribbon bar
	AddTab	Overloaded. Adds a new tab to the ribbon
	Dispose	Destructor for deterministic finalization of MainRibbon object.
	GetDefaultTab	Returns default tab
	GetTab	Overloaded. Returns tab by name, multilanguage
	RegisterCommand	Overloaded. Adds a command to the ribbon. If the ribbon doesn't exist yet, the command will be added after the system start is finished
	RemoveCommand	Removes command from Extensions->API group
	RemoveIcon	Removes custom icon from the ribbon bar
	UnregisterCommand	Overloaded. Removes a command from the ribbon. If the ribbon doesn't exist yet, the command will be removed after the system start is finished

Top

Reference

RibbonBar Members
Eplan.EplApi.Gui Namespace

Use the Eplan Global Support Portal for feedback and support