Set-PSReadLineKeyHandler

参考

模块:: PSReadLine

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

语法

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

Set-PSReadLineKeyHandler
   [-Chord] <String[]>
   [-ViMode <ViMode>]
   [-Function] <String>
   [<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 显示。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Chord

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

Ctrl+X,Ctrl+L

注意

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

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

Type:	String[]
Aliases:	Key
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

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

Type:	String
Aliases:	LongDescription
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Function

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

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ScriptBlock

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

Type:	ScriptBlock
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ViMode

指定绑定应用于哪个 vi 模式。

有效值为：

Insert
Command

Type:	ViMode
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

输入

None

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

输出