Set-PSReadLineKeyHandler

语法

ScriptBlock

Set-PSReadLineKeyHandler
    [-ScriptBlock] <ScriptBlock>
    [-Chord] <String[]>
    [-BriefDescription <String>]
    [-Description <String>]
    [-ViMode <ViMode>]
    [<CommonParameters>]

Function

Set-PSReadLineKeyHandler
    [-Chord] <String[]>
    [-Function] <String>
    [-ViMode <ViMode>]
    [<CommonParameters>]

说明

示例

Example 1: Bind the arrow key to a function

Set-PSReadLineKeyHandler -Chord UpArrow -Function HistorySearchBackward

Example 2: Bind a key to a script block

Set-PSReadLineKeyHandler -Chord Ctrl+b -ScriptBlock {
    [Microsoft.PowerShell.PSConsoleReadLine]::RevertLine()
    [Microsoft.PowerShell.PSConsoleReadLine]::Insert('build')
    [Microsoft.PowerShell.PSConsoleReadLine]::AcceptLine()
}

参数

-BriefDescription

A brief description of the key binding. This description is displayed by the Get-PSReadLineKeyHandler cmdlet.

参数属性

参数集

-Chord

The key or sequence of keys to be bound to a function or script block. Use a single string to specify a single binding. If the binding is a sequence of keys, separate the keys by a comma. For example: Ctrl+x,Ctrl+l

Letter key references are defined using lowercase letters. If you want to define a chord that uses an uppercase letter, the chord must include the Shift key. For example, Ctrl+Shift+x and Ctrl+x create different bindings.

This parameter accepts an array of strings. Each string is a separate binding, not a sequence of keys for a single binding.

参数属性

参数集

-Description

Specifies a more detailed description of the key binding that's visible in the output of the Get-PSReadLineKeyHandler cmdlet.

参数属性

参数集

-Function

Specifies the name of an existing key handler provided by PSReadLine. This parameter lets you rebind existing key bindings, or bind a handler that's currently unbound.

参数属性

参数集

-ScriptBlock

Specifies a script block value to run when the chord is entered. PSReadLine passes one or two parameters to this script block. The first parameter is a ConsoleKeyInfo object representing the key pressed. The second argument can be any object depending on the context.

参数属性

参数集

-ViMode

Specify which vi mode the binding applies to.

Valid values are:

• Insert
• Command

参数属性

参数集

CommonParameters

输入

None

输出

None

相关链接

• Get-PSReadLineKeyHandler
• Remove-PSReadLineKeyHandler
• Get-PSReadLineOption
• Set-PSReadLineOption