Set-PSReadLineKeyHandler (PSReadLine)

Set-PSReadLineKeyHandler

Modül:

PSReadLine

Anahtarları kullanıcı tanımlı veya PSReadLine anahtar işleyici işlevlerine bağlar.

Sözdizimi

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

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

Tanım

Set-PSReadLineKeyHandler cmdlet'i, bir tuşa veya tuş dizisine basıldığında sonucu özelleştirir. Kullanıcı tanımlı anahtar bağlamaları sayesinde bir PowerShell betiğinin içinden mümkün olan hemen hemen her şeyi yapabilirsiniz.

Örnekler

Örnek 1: Ok tuşunu bir işleve bağlayın

Bu komut, yukarı ok tuşunu HistorySearchBackward işlevine bağlar. Bu işlev, komut satırının geçerli içeriğiyle başlayan komut satırlarını bulmak için komut geçmişini arar.

Set-PSReadLineKeyHandler -Chord UpArrow -Function HistorySearchBackward

Örnek 2: Bir anahtarı bir komut dosyası bloğuna bağlama

Bu örnek, bir komutu çalıştırmak için tek bir anahtarın nasıl kullanılabileceğini gösterir. Komut, Ctrl+b anahtarını satırı temizleyen, "build" sözcüğünü ekleyen ve ardından satırı kabul eden bir komut dosyası bloğuna bağlar.

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

Parametreler

-BriefDescription

Anahtar bağlamanın kısa bir açıklaması. Bu açıklama Get-PSReadLineKeyHandler cmdlet'i tarafından görüntülenir.

Tip :

String

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Chord

Bir işleve veya komut dosyası bloğuna bağlanacak anahtar veya tuş dizisi. Tek bir bağlamayı belirtmek için tek bir dize kullanın. Bağlama bir anahtar dizisiyse, anahtarları virgülle ayırın. Örneğin: Ctrl+x,Ctrl+l

Harf anahtarı referansları küçük harfler kullanılarak tanımlanır. Büyük harf kullanan bir akor tanımlamak istiyorsanız akorun Shift tuşunu içermesi gerekir. Örneğin, Ctrl+Shift+x ve Ctrl+x farklı bağlamalar oluşturur.

Bu parametre bir dizi dizeyi kabul eder. Her dize, tek bir bağlama için bir anahtar dizisi değil, ayrı bir bağlamadır.

Tip :

String[]

Takma adlar:

Key

Konum:

0

Varsayılan değer:

None

Gerekli:

True

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Description

Get-PSReadLineKeyHandler cmdlet'inin çıktısında görünen anahtar bağlamanın daha ayrıntılı bir açıklamasını belirtir.

Tip :

String

Takma adlar:

LongDescription

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Function

PSReadLine tarafından sağlanan mevcut bir anahtar işleyicinin adını belirtir. Bu parametre, mevcut anahtar bağlamalarını yeniden bağlamanıza veya şu anda ilişkisiz olan bir işleyiciyi bağlamanıza olanak tanır.

Tip :

String

Konum:

1

Varsayılan değer:

None

Gerekli:

True

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-ScriptBlock

Akor girildiğinde çalıştırılacak kod bloğu değerini belirtir. PSReadLine bu komut dosyası bloğuna bir veya iki parametre iletir. İlk parametre, basılan tuşu temsil eden bir ConsoleKeyInfo nesnesidir. İkinci argüman bağlama bağlı olarak herhangi bir nesne olabilir.

Tip :

ScriptBlock

Konum:

1

Varsayılan değer:

None

Gerekli:

True

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-ViMode

Bağlamanın hangi vi moduna uygulanacağını belirtin.

Geçerli değerler şunlardır:

Insert

Command

Tip :

ViMode

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

Girişler

Yok

Nesneleri bu cmdlet'e aktaramazsınız.

Çıkışlar

Yok

Bu cmdlet hiçbir çıktı döndürmez.