Skip to content

MainMenuItem

interface cAlgo.API Since 5.4

DesktopCLICloud

Represents a item in main menu.

Environment behaviour

CLI — not supported. Available to plugins only, and plugins cannot run in the CLI.

Cloud — not supported. Available to plugins only, and plugins cannot run in the cloud.

Definition

public interface MainMenuItem

Namespace: cAlgo.API · Group: MainMenu

Examples

MainMenuItem selectedItem = MainMenu.SelectedItem;
var description = selectedItem switch
{
    MainMenuBuiltInItem builtInItem => builtInItem.Type.ToString(),
    MainMenuCustomItem customItem => customItem.Name,
    _ => "None"
};
Print("Selected main menu item: {0}", description);

selectedItem = api.MainMenu.SelectedItem
if isinstance(selectedItem.__implementation__, MainMenuBuiltInItem):
    api.Print(f"Selected main menu item: {MainMenuBuiltInItem(selectedItem).Type}")
elif isinstance(selectedItem.__implementation__, MainMenuCustomItem):
    api.Print(f"Selected main menu item: {MainMenuCustomItem(selectedItem).Name}")

See also