Bagikan melalui

Set-PSReadLineKeyHandler

Modul:
PSReadLine Module

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

Sintaks

ScriptBlock 

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

Function 

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

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

ScriptBlock
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Chord

Kunci atau urutan kunci yang akan terikat ke fungsi atau blok 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.

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:Kunci

Kumpulan parameter

(All)
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Description

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

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:LongDescription

Kumpulan parameter

ScriptBlock
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa: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.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Function
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa: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.

Properti parameter

Jenis:ScriptBlock
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

ScriptBlock
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ViMode

Tentukan mode vi mana yang berlaku untuk pengikatan.

Nilai yang valid adalah:

  • Insert
  • Command

Properti parameter

Jenis:ViMode
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

None

Anda tidak dapat menyalurkan objek ke cmdlet ini.

Output

None

Cmdlet ini tidak mengembalikan output.