Enum Command

Namespace

Terminal.Gui

Assembly

Terminal.Gui.dll

Actions which can be performed by a View.

public enum Command

Fields

Accept = 0

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

The default implementation in View calls RaiseAccepting(ICommandContext?). If the event is not handled, the command is invoked on: - Any peer-view that is a Button with IsDefault set to true. - The SuperView. This enables default Accept behavior.

BackTab = 62

Tabs back to the previous item.

Cancel = 68

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

Collapse = 66

Collapses a list or item (with subitems).

CollapseAll = 67

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

Context = 76

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

Copy = 52

Copies the current selection.

Cut = 53

Cuts the current selection.

CutToEndLine = 55

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

CutToStartLine = 56

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

DeleteAll = 41

Deletes all objects.

DeleteCharLeft = 39

Deletes the character on the left.

DeleteCharRight = 38

Deletes the character on the right.

DisableOverwrite = 37

Disables overwrite mode (EnableOverwrite)

Down = 4

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

DownExtend = 20

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

Edit = 77

Invokes a user interface for editing or configuring something.

EnableOverwrite = 35

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

End = 14

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

EndExtend = 28

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

EndOfPage = 12

Moves to the bottom of page.

Expand = 64

Expands a list or item (with subitems).

ExpandAll = 65

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

HotKey = 1

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

The default implementation in View calls SetFocus() and then RaiseHandlingHotKey().

Insert = 36

Inserts a character.

KillWordBackwards = 33

Deletes the characters backwards.

KillWordForwards = 32

Deletes the characters forwards.

Left = 5

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

LeftExtend = 21

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

LeftStart = 15

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

LeftStartExtend = 29

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

LineDownToLastBranch = 44

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

LineUpToFirstBranch = 45

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

New = 75

Creates a new document.

NewLine = 42

Inserts a new item.

NextTabGroup = 59

Moves focus to the next TabGroup.

NextTabStop = 57

Moves focus to the next TabStop.

Open = 72

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

PageDown = 8

Move one page down.

PageDownExtend = 25

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

PageLeft = 9

Moves to the left page.

PageRight = 10

Moves to the right page.

PageUp = 7

Move one page up.

PageUpExtend = 26

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

Paste = 54

Pastes the current selection.

PreviousTabGroup = 60

Moves focus to the nextTabGroup.

PreviousTabStop = 58

Moves focus to the previous TabStop.

Quit = 69

Quit.

Redo = 51

Redo changes.

Refresh = 70

Refresh.

Right = 6

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

RightEnd = 16

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

RightEndExtend = 30

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

RightExtend = 22

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

Save = 73

Saves the current document.

SaveAs = 74

Saves the current document with a new name.

ScrollDown = 46

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

ScrollLeft = 48

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

ScrollRight = 49

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

ScrollUp = 47

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

Select = 2

Selects the View or an item in the View (e.g. a list item or menu item) without necessarily accepting it.

The default implementation in View calls RaiseSelecting(ICommandContext?).

SelectAll = 40

Selects all objects.

Start = 13

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

StartExtend = 27

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

StartOfPage = 11

Moves to the top of page.

Suspend = 71

Suspend an application (Only implemented in Terminal.Gui.CursesDriver).

Tab = 61

Tabs to the next item.

Toggle = 63

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

ToggleExtend = 31

Toggles the selection.

ToggleOverwrite = 34

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

Undo = 50

Undo changes.

UnixEmulation = 43

Unix emulation.

Up = 3

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

UpExtend = 19

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

WordLeft = 17

Moves to the start of the previous word.

WordLeftExtend = 23

Extends the selection to the start of the previous word.

WordRight = 18

Moves the start of the next word.

WordRightExtend = 24

Extends the selection to the start of the next word.

Remarks

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

See Also

KeyBindings

MouseBindings

KeyBindings