Enum Command

Namespace

Terminal.Gui.Input

Assembly

Terminal.Gui.dll

Actions which can be performed by a View.

public enum Command

Extension Methods

CommandExtensions.AsInt32(Command)

CommandExtensions.AsUInt32(Command)

CommandExtensions.FastIsDefined(Command, int)

Fields

Accept = 1

Accepts the current state of the View (e.g. list selection, button press, checkbox state, etc.).

The default implementation in View raises the Accepting and Accepting events.

Activate = 3

Activates the View or an item in the View, changing its state or preparing it for interaction (e.g. toggling a checkbox, selecting a list item, focusing a button, navigating a menu item) without necessarily accepting it.

The default implementation in View raises the Activating event. If Activating is not handled, SetFocus() will be called and the Activated event will be raised.

Arrange = 69

Enables arrange mode.

Cancel = 75

Cancels an action or any temporary states on the control e.g. expanding a combo list.

Center = 85

Centers the current item or viewport.

Collapse = 73

Collapses a list or item (with subitems).

CollapseAll = 74

Recursively collapses a list items of their children (if any).

Context = 83

Shows context about the item (e.g. a context menu).

Copy = 60

Copies the current selection.

Cut = 61

Cuts the current selection.

CutToEndOfLine = 63

Cuts to the clipboard the characters from the current position to the end of the line.

CutToStartOfLine = 64

Cuts to the clipboard the characters from the current position to the start of the line.

DeleteAll = 43

Deletes all objects.

DeleteCharLeft = 41

Deletes the character on the left.

DeleteCharRight = 40

Deletes the character on the right.

DisableOverwrite = 39

Disables overwrite mode (EnableOverwrite)

Down = 5

Moves down one item (cell, line, etc...).

DownExtend = 22

Extends the selection down one (cell, line, etc...).

Edit = 84

Invokes a user interface for editing or configuring something.

EnableOverwrite = 37

Enables overwrite mode such that newly typed text overwrites the text that is already there (typically associated with the Insert key).

End = 16

Moves to the end (e.g. the bottom).

EndExtend = 30

Extends the selection to end (e.g. bottom).

EndOfPage = 13

Moves to the bottom of page.

Expand = 71

Expands a list or item (with subitems).

ExpandAll = 72

Recursively Expands all child items and their child items (if any).

Find = 48

Opens or activates a find/search UI.

FindNext = 49

Finds the next match.

FindPrevious = 50

Finds the previous match.

Home = 15

Moves or resets to the home position.

HotKey = 2

Performs a hot key action (e.g. setting focus, accepting, and/or moving focus to the next View).

The default implementation in View raises the HandlingHotKey event and if that is not handled, invokes Activate.

Insert = 38

Inserts a character.

InsertCaretAbove = 88

Adds an additional caret one line above the topmost caret (multi-caret editing), preserving the sticky visual column. Mirrors VS Code's editor.action.insertCursorAbove. Views that support multi-caret bind this through KeyBindings or their configurable default key bindings.

InsertCaretBelow = 89

Adds an additional caret one line below the bottommost caret (multi-caret editing), preserving the sticky visual column. Mirrors VS Code's editor.action.insertCursorBelow. Views that support multi-caret bind this through KeyBindings or their configurable default key bindings.

InsertTab = 46

Inserts a tab character or spaces at the cursor or selection.

KillWordLeft = 35

Deletes the word to left to the cursor.

KillWordRight = 34

Deletes the word to the right of the cursor.

Left = 6

Moves left one (cell, line, etc...).

LeftExtend = 23

Extends the selection left one item (cell, line, etc...)

LeftStart = 17

Moves left to the start on the current row/line.

LeftStartExtend = 31

Extends the selection to the start on the current row/line.

LineDownToLastBranch = 52

Moves down to the last child node of the branch that holds the current selection.

LineUpToFirstBranch = 53

Moves up to the first child node of the branch that holds the current selection.

New = 82

Creates a new document.

NewLine = 44

Inserts a new item.

NextTabGroup = 67

Moves focus to the next TabGroup.

NextTabStop = 65

Moves focus to the next TabStop.

NotBound = 0

Indicates the command is not bound or invalid. Will call RaiseCommandNotBound(ICommandContext?).

Open = 79

Open the selected item or invoke a UI for opening something.

PageDown = 9

Move one page down.

PageDownExtend = 27

Move one page down extending the selection to cover revealed objects/characters.

PageLeft = 10

Moves to the left page.

PageRight = 11

Moves to the right page.

PageUp = 8

Move one page up.

PageUpExtend = 28

Move one page up extending the selection to cover revealed objects/characters.

Paste = 62

Pastes the current selection.

PreviousTabGroup = 68

Moves focus to the nextTabGroup.

PreviousTabStop = 66

Moves focus to the previous TabStop.

Quit = 76

Quit.

Redo = 59

Redo changes.

Refresh = 77

Refresh.

Replace = 51

Opens or activates a find-and-replace UI.

Right = 7

Moves right one (cell, line, etc...).

RightEnd = 18

Moves right to the end on the current row/line.

RightEndExtend = 32

Extends the selection to the right on the current row/line.

RightExtend = 24

Extends the selection right one item (cell, line, etc...)

Save = 80

Saves the current document.

SaveAs = 81

Saves the current document with a new name.

ScrollDown = 54

Scrolls down one (cell, line, etc...).

ScrollLeft = 56

Scrolls one item (cell, character, etc...) to the left.

ScrollRight = 57

Scrolls one item (cell, character, etc...) to the right.

ScrollUp = 55

Scrolls up one item (cell, line, etc...).

SelectAll = 42

Selects all objects.

Start = 14

Moves to the start (e.g. the top or home).

StartExtend = 29

Extends the selection to start (e.g. home or top).

StartOfPage = 12

Moves to the top of page.

StartRectangleSelection = 91

Starts extending a rectangular selection via pointing-device input.

StartSelection = 90

Starts extending a selection via pointing-device input.

Suspend = 78

Suspend an application (Only implemented in UnixDriver).

Toggle = 70

Toggles something (e.g. the expanded or collapsed state of a list).

ToggleExtend = 33

Toggles the selection (or a specific element of the selection).

ToggleOverwrite = 36

Toggles overwrite mode such that newly typed text overwrites the text that is already there (typically associated with the Insert key).

Undo = 58

Undo changes.

Unindent = 47

Removes one level of indentation from the current line or selection.

UnixEmulation = 45

Unix emulation.

Up = 4

Moves up one (cell, line, etc...).

UpExtend = 21

Extends the selection up one item (cell, line, etc...).

WordLeft = 19

Moves to the start of the previous word.

WordLeftExtend = 25

Extends the selection to the start of the previous word.

WordRight = 20

Moves the start of the next word.

WordRightExtend = 26

Extends the selection to the start of the next word.

ZoomIn = 86

Zooms in.

ZoomOut = 87

Zooms out.

Remarks

Application supports a subset of these commands by default, which can be overriden via KeyBindings.

See the Commands Deep Dive for more information: https://gui-cs.github.io/Terminal.Gui/docs/command.html.

See Also

KeyBindings

MouseBindings

KeyBindings

KeyBinding

MouseBinding

ICommandBinding

InvokeCommand(Command)

CommandContext