Skip to main content

IArlecchinoCommand interface

Namespace: Arlecchino.Commands · Assembly: Arlecchino

An application-wide command. It appears in the command palette from every screen, and fires globally when its binding carries a modifier — a plain letter would swallow typing, so those are only reachable through the palette.

public interface IArlecchinoCommand

Properties​

MemberSummary
BindingKey that runs the command.
IconShort marker to draw beside the label; yours to use or ignore.
LabelName shown in the palette.

Methods​

MemberSummary
Execute()Runs the command.

Properties in detail​

Binding​

public KeyBinding Binding { get; }

Key that runs the command.

Type KeyBinding

Icon​

public string Icon { get; }

Short marker to draw beside the label; yours to use or ignore.

Type string

Label​

public string Label { get; }

Name shown in the palette.

Type string

Methods in detail​

Execute()​

public ViewRoute Execute();

Runs the command.

Returns ViewRoute — A route to navigate to, or ViewRoute.None to stay.