通过

Set-PSReadLineKeyHandler

模块:
PSReadLine Module

将密钥绑定到用户定义的或 PSReadLine 键处理程序函数。

语法

ScriptBlock 

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

Function 

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

说明

当按下按键或按键序列时，Set-PSReadLineKeyHandler cmdlet 会自定义结果。 使用用户定义的密钥绑定，可以从 PowerShell 脚本中执行几乎任何可能的事情。

示例

示例 1：将箭头键绑定到函数

此命令将向上箭头键绑定到 HistorySearchBackward 函数。 此函数在命令历史记录中搜索以命令行的当前内容开头的命令行。

Set-PSReadLineKeyHandler -Chord UpArrow -Function HistorySearchBackward

示例 2：将密钥绑定到脚本块

此示例演示如何使用单个键来运行命令。 该命令将 Ctrl+B 键绑定到某个脚本块，该脚本块清除行，插入单词“build”，然后接受该行。

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

参数

-BriefDescription

密钥绑定的简要说明。 此说明由 Get-PSReadLineKeyHandler 命令（cmdlet）显示。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ScriptBlock
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Chord

要绑定到函数或脚本块的键或键序列。 使用单个字符串指定单个绑定。 如果绑定是一系列键，则用逗号分隔键，如以下示例所示：

Ctrl+X,Ctrl+L

注释

从 PSReadLine 2.0.0 开始， Chord 参数 区分大小写。 这意味着， Ctrl+X 和 Ctrl+x 创建不同的绑定。

此参数接受字符串数组。 每个字符串都是一个单独的绑定，而不是单个绑定的键序列。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False
别名:密钥

参数集

(All)
Position:0
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Description

指定在 Get-PSReadLineKeyHandler cmdlet 的输出中显示的键绑定的更详细说明。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:LongDescription

参数集

ScriptBlock
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Function

指定 PSReadLine 提供的现有密钥处理程序的名称。 此参数允许你重新绑定现有键绑定，或绑定当前未绑定的处理程序。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

Function
Position:1
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-ScriptBlock

指定在输入和弦时要运行的脚本块的值。 PSReadLine 将一个或两个参数传递给此脚本块。 第一个参数是表示按下键的 ConsoleKeyInfo 对象。 第二个参数可以是任何对象，具体取决于上下文。

参数属性

类型:ScriptBlock
默认值:None
支持通配符:False
不显示:False

参数集

ScriptBlock
Position:1
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-ViMode

指定绑定适用的 vi 模式。

有效值为：

  • Insert
  • Command

参数属性

类型:ViMode
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输入

None

不能通过管道将对象传递给此 cmdlet。

输出

None

此 cmdlet 将不生成任何输出。