Udostępnij przez

Set-PSReadLineKeyHandler

Moduł:
PSReadLine Module

Wiąże klucze z funkcjami obsługi kluczy zdefiniowanymi przez użytkownika lub PSReadLine.

Składnia

ScriptBlock 

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

Function 

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

Opis

Polecenie cmdlet Set-PSReadLineKeyHandler dostosowuje wynik po naciśnięciu lub sekwencji. W przypadku powiązań kluczy zdefiniowanych przez użytkownika można wykonać niemal wszystko, co jest możliwe w skryscie programu PowerShell.

Przykłady

Przykład 1. Powiązanie strzałki z funkcją

To polecenie wiąże strzałki w górę z funkcją HistorySearchBackward. Ta funkcja wyszukuje historię poleceń wierszy polecenia rozpoczynających się od bieżącej zawartości wiersza polecenia.

Set-PSReadLineKeyHandler -Chord UpArrow -Function HistorySearchBackward

Przykład 2. Powiązanie klucza z blokiem skryptu

W tym przykładzie pokazano, jak można użyć pojedynczego klucza do uruchomienia polecenia. Polecenie wiąże klucz Ctrl+b z blokiem skryptu, który czyści wiersz, wstawia słowo "build", a następnie akceptuje wiersz.

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

Parametry

-BriefDescription

Krótki opis powiązania klucza. Ten opis jest wyświetlany przez polecenie cmdlet Get-PSReadLineKeyHandler.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ScriptBlock
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Chord

Klucz lub sekwencja kluczy, które mają być powiązane z funkcją lub blokiem skryptu. Użyj jednego ciągu, aby określić pojedyncze powiązanie. Jeśli powiązanie jest sekwencją kluczy, należy oddzielić klucze przecinkami. Przykład: Ctrl+x,Ctrl+l

Odwołania do klucza litery są definiowane przy użyciu małych liter. Jeśli chcesz zdefiniować akord używający wielkiej litery, akord musi zawierać klucz Shift. Na przykład Ctrl+Shift+x i Ctrl+x tworzyć różne powiązania.

Ten parametr akceptuje tablicę ciągów. Każdy ciąg jest oddzielnym powiązaniem, a nie sekwencją kluczy dla pojedynczego powiązania.

Właściwości parametru

Typ:

String[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Klawisz

Zestawy parametrów

(All)
Position:0
Obowiązkowy:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Description

Określa bardziej szczegółowy opis powiązania klucza widocznego w danych wyjściowych polecenia cmdlet Get-PSReadLineKeyHandler.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:LongDescription

Zestawy parametrów

ScriptBlock
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Function

Określa nazwę istniejącej procedury obsługi kluczy dostarczonej przez program PSReadLine. Ten parametr umożliwia ponowne powiązanie istniejących powiązań kluczy lub powiązanie procedury obsługi, która jest obecnie niezwiązana.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

Function
Position:1
Obowiązkowy:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ScriptBlock

Określa wartość bloku skryptu do uruchomienia po wprowadzeniu akordu. Funkcja PSReadLine przekazuje jeden lub dwa parametry do tego bloku skryptu. Pierwszy parametr jest obiektem ConsoleKeyInfo reprezentującym naciśnięcie. Drugi argument może być dowolnym obiektem w zależności od kontekstu.

Właściwości parametru

Typ:ScriptBlock
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ScriptBlock
Position:1
Obowiązkowy:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ViMode

Określ tryb vi, do którego ma zastosowanie powiązanie.

Prawidłowe wartości to:

  • Insert
  • Command

Właściwości parametru

Typ:ViMode
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

None

Nie można przekazywać obiektów do tego cmdletu.

Dane wyjściowe

None

To polecenie cmdlet nie zwraca żadnych danych wyjściowych.