PSConsoleReadLine Class

Abort current action, e.g. incremental history search.

Attempt to execute the current input. If it can be executed (like AcceptLine), then recall the next item from history the next time ReadLine is called.

Attempt to execute the current input. If the current input is incomplete (for example there is a missing closing parenthesis, bracket, or quote, then the continuation prompt is displayed on the next line and PSReadLine waits for keys to edit the current input.

The continuation prompt is displayed on the next line and PSReadLine waits for keys to edit the current input. This is useful to enter multi-line input as a single command even when a single line is complete input by itself.

Add a command to the history - typically used to restore history from a previous session.

Move the cursor one character to the left. This may move the cursor to the previous line of multi-line input.

Delete the character before the cursor.

Like BackwardKillLine - deletes text from the point to the start of the line, but does not put the deleted text in the kill ring.

Deletes the previous word.

Clear the input from the start of the input to the cursor. The cleared text is placed in the kill ring.

Clear the input from the start of the current word to the cursor. If the cursor is between words, the input is cleared from the start of the previous word to the cursor. The cleared text is placed in the kill ring.

Move the cursor back to the start of the current word, or if between words, the start of the previous word. Word boundaries are defined by a configurable set of characters.

Move to the first item in the history.

If the input has multiple lines, move to the start of the current line, or if already at the start of the line, move to the start of the input. If the input has a single line, move to the start of the input.

Cancel the current input, leaving the input on the screen, but returns back to the host so the prompt is evaluated again.

Start interactive screen capture - up/down arrows select lines, enter copies selected text to clipboard as text and html.

Read a character and search forward for the next occurence of that character. If an argument is specified, search forward (or backward if negative) for the nth occurence.

Read a character and search backward for the next occurence of that character. If an argument is specified, search backward (or forward if negative) for the nth occurence.

Clears history in PSReadLine. This does not affect PowerShell history.

The contents of the kill ring are cleared.

Clear the screen and draw the current line at the top of the screen.

Attempt to perform completion on the text surrounding the cursor. If there are multiple possible completions, the longest unambiguous prefix is used for completion. If trying to complete the longest unambiguous completion, a list of possible completions is displayed.

Copy selected region to the system clipboard. If no region is selected, copy the whole line.

If text is selected, copy to the clipboard, otherwise cancel the line.

Delete selected region placing deleted text in the system clipboard.

Delete some text at the given position. Supports undo.

Delete the character under the cursor.

Delete the character under the cursor, or if the line is empty, exit the process.

Delete to the end of the word.

Deletes the current line, enabling undo.

Deletes text from the cursor to the first non-blank character of the line.

Delete to the end of the line.

Delete the next word.

Start a new digit argument to pass to other functions.

Notify the user based on their preference for notification.

Move to the last item (the current input) in the history.

If the input has multiple lines, move to the end of the current line, or if already at the end of the line, move to the end of the input. If the input has a single line, move to the end of the input.

The cursor is placed at the location of the mark and the mark is moved to the location of the cursor.

Move the cursor one character to the right. This may move the cursor to the next line of multi-line input.

Like ForwardKillLine - deletes text from the point to the end of the line, but does not put the deleted text in the kill ring.

Perform an incremental forward search through history.

Move the cursor forward to the end of the current word, or if between words, to the end of the next word. Word boundaries are defined by a configurable set of characters.

Get the state of the buffer - the ast, tokens, errors, and position of the cursor

Get the state of the buffer - the current input and the position of the cursor

Used to group the built in functions for help and Get-PSReadLineKeyHander output.

Return a collection of history items.

Return all bound key handlers.

Helper function for the Get-PSReadLineKeyHandler cmdlet.

Helper function for the Get-PSReadLineOption cmdlet.

Get the selection state of the buffer

Go to the matching brace, paren, or square bracket.

Move to the column indicated by arg.

Move the cursor to the first non-blank character in the line.

Replace the current input with the 'previous' item from PSReadLine history that matches the characters between the start and the input and the cursor.

Replace the current input with the 'next' item from PSReadLine history that matches the characters between the start and the input and the cursor.

Insert a character at the current position. Supports undo.

Insert a string at the current position. Supports undo.

A new empty line is created above the current line regardless of where the cursor is on the current line. The cursor moves to the beginning of the new line.

A new empty line is created below the current line regardless of where the cursor is on the current line. The cursor moves to the beginning of the new line.

Invert the case of the current character and move to the next one.

Returns true if in Vi Command mode, otherwise false.

Returns true if in Vi Insert mode, otherwise false.

Erases the current prompt and calls the prompt function to redisplay the prompt. Useful for custom key handlers that change state, e.g. change the current directory.

Clear the input from the cursor to the end of the input. The cleared text is placed in the kill ring.

Kill the text between the cursor and the mark.

Clear the input from the cursor to the end of the current word. If the cursor is between words, the input is cleared from the cursor to the end of the next word. The cleared text is placed in the kill ring.

Attempt to perform completion on the text surrounding the cursor. If there are multiple possible completions, the longest unambiguous prefix is used for completion. If trying to complete the longest unambiguous completion, a list of possible completions is displayed.

Move the cursor to the end of the input.

Replace the current input with the 'next' item from PSReadLine history.

Move the cursor to the next line.

Move the cursor forward to the start of the next word. Word boundaries are defined by a configurable set of characters.

Move the cursor forward to the end of the current word, or if between words, to the end of the next word. Word boundaries are defined by a configurable set of characters.

Paste text from the system clipboard.

Paste the clipboard after the cursor, moving the cursor to the end of the pasted text.

Paste the clipboard before the cursor, moving the cursor to the end of the pasted text.

Display the list of possible completions.

Prepend a '#' and accept the line.

Replace the current input with the 'previous' item from PSReadLine history.

Move the cursor to the previous line.

Entry point - called from the PowerShell function PSConsoleHostReadLine after the prompt has been displayed.

Undo an undo.

Helper function for the Remove-PSReadLineKeyHandler cmdlet.

Repeat the last recorded character search.

Repeat the last recorded character search, but in the opposite direction.

Repeat the last text modification.

Repeat the last search in the same direction as before.

Repeat the last search in the same direction as before.

Replace some text at the given position. Supports undo.

Perform an incremental backward search through history.

Reverts all of the input to the current input.

Scroll the display down one screen.

Scroll the display down one line.

Scroll the display to the cursor.

Scroll the display to the top.

Scroll the display up one screen.

Scroll the display up one line.

Read the next character and then find it, going forward, and then back off a character. This is for 't' functionality.

Read the next character and then find it, going backward, and then back off a character. This is for 'T' functionality.

Read the next character and then find it, going backward, and then back off a character. This is for 'T' functionality.

Read the next character and then find it, going forward, and then back off a character. This is for 't' functionality.

Prompts for a search string and initiates search upon AcceptLine.

Select the entire line.

Adjust the current selection to include the previous character.

Adjust the current selection to include from the cursor to the start of the line.

Adjust the current selection to include the previous word.

Adjust the current selection to include the next character.

Adjust the current selection to include the next word using ForwardWord.

Adjust the current selection to include from the cursor to the end of the line.

Adjust the current selection to include the next word.

Adjust the current selection to include the previous word using ShellBackwardWord.

Adjust the current selection to include the next word using ShellForwardWord.

Adjust the current selection to include the next word using ShellNextWord.

Insert the key.

Set the position of the cursor.

Helper function for the Set-PSReadLineKeyHandler cmdlet.

Helper function for the Set-PSReadLineKeyHandler cmdlet.

Mark the current location of the cursor for use in a subsequent editing command.

Helper function for the Set-PSReadLineOption cmdlet.

Clear the input from the start of the current word to the cursor. If the cursor is between words, the input is cleared from the start of the previous word to the cursor. The cleared text is placed in the kill ring.

Move the cursor back to the start of the current word, or if between words, the start of the previous word. Word boundaries are defined by PowerShell tokens.

Move the cursor forward to the start of the next word. Word boundaries are defined by PowerShell tokens.

Clear the input from the cursor to the end of the current word. If the cursor is between words, the input is cleared from the cursor to the end of the next word. The cleared text is placed in the kill ring.

Move the cursor forward to the end of the current word, or if between words, to the end of the next word. Word boundaries are defined by PowerShell tokens.

Show all bound keys.

Swap the current character and the one before it.

Attempt to complete the text surrounding the cursor with the next available completion.

Attempt to complete the text surrounding the cursor with the previous available completion.

A helper method when your function expects an optional int argument (e.g. from DigitArgument) If there is not argument (it's null), returns true and sets numericArg to defaultNumericArg. Dings and returns false if the argument is not an int (no conversion is attempted) Otherwise returns true, and numericArg has the result.

Undo a previous edit.

Undo all previous edits for line.

Clear the input from the start of the current word to the cursor. If the cursor is between words, the input is cleared from the start of the previous word to the cursor. The cleared text is placed in the kill ring.

Attempt to execute the current input. If the current input is incomplete (for example there is a missing closing parenthesis, bracket, or quote, then the continuation prompt is displayed on the next line and PSReadLine waits for keys to edit the current input.

Accept the line and switch to Insert mode.

Like DeleteCharOrExit in Emacs mode, but accepts the line instead of deleting a character.

A new line is inserted below the current line.

Deletes the previous word, using only white space as the word delimiter.

Moves the cursor back to the beginning of the previous word, using only white space as delimiters.

Move the cursor back to the start of the current word, or if between words, the start of the previous word. Word boundaries are defined by a configurable set of characters.

Switch the current operating mode from Vi-Insert to Vi-Command.

Find the matching brace, paren, or square bracket and delete all contents within, including the brace.

Delete to the end of the word.

Delete the next glob (white space delimited word).

Deletes until given character.

Deletes until given character.

Deletes until given character.

Deletes until given character.

Deletes until given character.

Deletes backwards until given character.

Deletes backwards until given character.

Start a new digit argument to pass to other functions while in one of vi's chords.

Edit the command line in a text editor specified by $env:EDITOR or $env:VISUAL.

Moves the cursor to the end of the word, using only white space as delimiters.

Moves to the end of the previous word, using only white space as a word delimiter.

Exits the shell.

Similar to GotoBrace(Nullable<ConsoleKeyInfo>, Object), but is character based instead of token based.

Switch to Insert mode and position the cursor at the beginning of the line.

Switch to Insert mode and position the cursor at the end of the line.

A new line is inserted above the current line.

Switch to Insert mode.

Append from the current line position.

Delete the current character and switch to Insert mode.

Joins the current line and the next line.

Moves to the next word, using only white space as a word delimiter.

Move the cursor forward to the start of the next word. Word boundaries are defined by a configurable set of characters.

Erase the entire command line.

Replaces until given character.

Replaces until given character.

Deletes until given character.

Replaces until given character.

Prompts for a search string and initiates search upon AcceptLine.

Ends the current edit group, if needed, and invokes TabCompleteNext.

Ends the current edit group, if needed, and invokes TabCompletePrevious.

Yank from the beginning of the buffer to the cursor.

Yank from the cursor to the end of the WORD(s).

Yank from the cursor to the end of the word(s).

Yank character(s) to the left of the cursor.

Yank the entire buffer.

Yank from cursor to the start of the next WORD(s).

Yank the word(s) after the cursor.

Yank to/from matching brace.

Yank from beginning of the WORD(s) to cursor.

Yank the word(s) before the cursor.

Yank character(s) under and to the right of the cursor.

Yank from the cursor to the end of the buffer.

Yank from the first non-whitespace character to the cursor.

Read a key and tell me what the key is bound to.

Add the most recently killed text to the input.

Yank the last argument from the previous history line. With an argument, the first time it is invoked, behaves just like YankNthArg. If invoked multiple times, instead it iterates through history and arg sets the direction (negative reverses the direction.)

Yank the first argument (after the command) from the previous history line. With an argument, yank the nth argument (starting from 0), if the argument is negative, start from the last argument.

If the previous operation was Yank or YankPop, replace the previously yanked text with the next killed text from the kill ring.