Compartilhar via

Set-PSReadLineKeyHandler

  • Referência
Módulo:
PSReadLine

Associa chaves a funções de manipulador de chave PSReadLine ou definidas pelo usuário.

Sintaxe

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

Description

O cmdlet Set-PSReadLineKeyHandler personaliza o resultado quando uma tecla ou sequência de teclas é pressionada. Com associações de chave definidas pelo usuário, você pode fazer quase tudo o que for possível em um script do PowerShell.

Exemplos

Exemplo 1: Associar a tecla de direção a uma função

Esse comando associa a tecla de seta para cima à função HistorySearchBackward. Essa função pesquisa o histórico de comandos em busca de linhas de comando que começam com o conteúdo atual da linha de comando.

Set-PSReadLineKeyHandler -Chord UpArrow -Function HistorySearchBackward

Exemplo 2: associar uma chave a um bloco de script

Este exemplo mostra como uma única chave pode ser usada para executar um comando. O comando associa a chave Ctrl+b a um bloco de script que limpa a linha, insere a palavra "build" e aceita a linha.

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

Parâmetros

-BriefDescription

Uma breve descrição da associação de chave. Esta descrição é exibida pelo cmdlet Get-PSReadLineKeyHandler.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Chord

A chave ou a sequência de chaves a serem associadas a uma função ou bloco de script. Use uma única cadeia de caracteres para especificar uma única associação. Se a associação for uma sequência de chaves, separe as chaves por vírgula. Por exemplo: Ctrl+x,Ctrl+l

As referências de chave de letra são definidas usando letras minúsculas. Se você quiser definir um acorde que use uma letra maiúscula, o acorde deverá incluir a tecla Shift. Por exemplo, Ctrl+Shift+x e Ctrl+x criar associações diferentes.

Esse parâmetro aceita uma matriz de cadeias de caracteres. Cada cadeia de caracteres é uma associação separada, não uma sequência de chaves para uma única associação.

Tipo:String[]
Aliases:Key
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Description

Especifica uma descrição mais detalhada da associação de chave visível na saída do cmdlet Get-PSReadLineKeyHandler.

Tipo:String
Aliases:LongDescription
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Function

Especifica o nome de um manipulador de chaves existente fornecido pelo PSReadLine. Esse parâmetro permite que você revincula as associações de chave existentes ou associe um manipulador que está desvinculado no momento.

Tipo:String
Cargo:1
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ScriptBlock

Especifica um valor de bloco de script a ser executado quando o acorde é inserido. O PSReadLine passa um ou dois parâmetros para esse bloco de script. O primeiro parâmetro é um objeto ConsoleKeyInfo que representa a tecla pressionada. O segundo argumento pode ser qualquer objeto dependendo do contexto.

Tipo:ScriptBlock
Cargo:1
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ViMode

Especifique a qual modo vi a associação se aplica.

Os valores válidos são:

  • Insert
  • Command
Tipo:ViMode
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

None

Você não pode redirecionar objetos para este cmdlet.

Saídas

None

Esse cmdlet não retorna nenhuma saída.