Set-PSReadLineKeyHandler

Referensi

Modul:: PSReadLine

Mengikat kunci ke fungsi handler kunci yang ditentukan pengguna atau PSReadLine.

Sintaks

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

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

Deskripsi

cmdlet Set-PSReadLineKeyHandler menyesuaikan hasil ketika kunci atau urutan tombol ditekan. Dengan pengikatan kunci yang ditentukan pengguna, Anda dapat melakukan hampir semua yang mungkin dari dalam skrip PowerShell.

Contoh

Contoh 1: Mengikat tombol panah ke fungsi

Perintah ini mengikat tombol panah atas ke fungsi HistorySearchBackward. Fungsi ini mencari riwayat perintah untuk baris perintah yang dimulai dengan konten baris perintah saat ini.

Set-PSReadLineKeyHandler -Chord UpArrow -Function HistorySearchBackward

Contoh 2: Mengikat kunci ke blok skrip

Contoh ini menunjukkan bagaimana satu kunci dapat digunakan untuk menjalankan perintah. Perintah mengikat kunci Ctrl+b ke blok skrip yang menghapus baris, menyisipkan kata "build", lalu menerima baris.

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

Parameter

-BriefDescription

Deskripsi singkat tentang pengikatan kunci. Deskripsi ini ditampilkan oleh cmdlet Get-PSReadLineKeyHandler.

Jenis:	String
Position:	Named
Nilai default:	None
Diperlukan:	False
Terima input alur:	False
Terima karakter wildcard:	False

-Chord

Kunci atau urutan kunci yang akan terikat ke blok fungsi atau skrip. Gunakan string tunggal untuk menentukan satu pengikatan. Jika pengikatan adalah urutan kunci, pisahkan kunci dengan koma. Misalnya: Ctrl+x,Ctrl+l

Referensi kunci huruf didefinisikan menggunakan huruf kecil. Jika Anda ingin menentukan akord yang menggunakan huruf besar, akor harus menyertakan kunci Shift. Misalnya, Ctrl+Shift+x dan Ctrl+x membuat pengikatan yang berbeda.

Parameter ini menerima array string. Setiap string adalah pengikatan terpisah, bukan urutan kunci untuk satu pengikatan.

Jenis:	String[]
Alias:	Key
Position:	0
Nilai default:	None
Diperlukan:	True
Terima input alur:	False
Terima karakter wildcard:	False

-Description

Menentukan deskripsi yang lebih rinci tentang pengikatan kunci yang terlihat dalam output cmdlet Get-PSReadLineKeyHandler.

Jenis:	String
Alias:	LongDescription
Position:	Named
Nilai default:	None
Diperlukan:	False
Terima input alur:	False
Terima karakter wildcard:	False

-Function

Menentukan nama handler kunci yang ada yang disediakan oleh PSReadLine. Parameter ini memungkinkan Anda mengikat kembali pengikatan kunci yang ada, atau mengikat handler yang saat ini tidak terikat.

Jenis:	String
Position:	1
Nilai default:	None
Diperlukan:	True
Terima input alur:	False
Terima karakter wildcard:	False

-ScriptBlock

Menentukan nilai blok skrip yang akan dijalankan saat akor dimasukkan. PSReadLine meneruskan satu atau dua parameter ke blok skrip ini. Parameter pertama adalah objek ConsoleKeyInfo yang mewakili tombol yang ditekan. Argumen kedua dapat berupa objek apa pun tergantung pada konteksnya.

Jenis:	ScriptBlock
Position:	1
Nilai default:	None
Diperlukan:	True
Terima input alur:	False
Terima karakter wildcard:	False

-ViMode

Tentukan mode vi mana yang berlaku untuk pengikatan.

Nilai yang valid adalah:

Insert
Command

Jenis:	ViMode
Position:	Named
Nilai default:	None
Diperlukan:	False
Terima input alur:	False
Terima karakter wildcard:	False

Input

None

Anda tidak dapat menyalurkan objek ke cmdlet ini.

Output