Delen via

Set-PSReadLineKeyHandler

Module:
PSReadLine Module

Hiermee worden sleutels gekoppeld aan door de gebruiker gedefinieerde of PSReadLine-sleutelhandlerfuncties.

Syntaxis

ScriptBlock 

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

Function 

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

Description

De Set-PSReadLineKeyHandler cmdlet past het resultaat aan wanneer een toets of reeks toetsen wordt ingedrukt. Met door de gebruiker gedefinieerde sleutelbindingen kunt u vrijwel alles doen wat mogelijk is vanuit een PowerShell-script.

Voorbeelden

Voorbeeld 1: De pijltoets verbinden met een functie

Deze opdracht koppelt de pijl-omhoogtoets aan de functie HistorySearchBackward. Met deze functie wordt in de opdrachtgeschiedenis gezocht naar opdrachtregels die beginnen met de huidige inhoud van de opdrachtregel.

Set-PSReadLineKeyHandler -Chord UpArrow -Function HistorySearchBackward

Voorbeeld 2: Een sleutel binden aan een scriptblok

In dit voorbeeld ziet u hoe één sleutel kan worden gebruikt om een opdracht uit te voeren. De opdracht verbindt de sleutel Ctrl+b met een scriptblok waarmee de regel wordt gewist, het woord 'build' wordt ingevoegd en vervolgens de regel wordt geaccepteerd.

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

Parameters

-BriefDescription

Een korte beschrijving van de sleutelbinding. Deze beschrijving wordt weergegeven door de Get-PSReadLineKeyHandler cmdlet.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

ScriptBlock
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Chord

De sleutel of reeks sleutels die moeten worden gebonden aan een functie- of scriptblok. Gebruik één tekenreeks om één binding op te geven. Als de binding een reeks sleutels is, scheidt u de sleutels door een komma. Bijvoorbeeld: Ctrl+x,Ctrl+l

Sleutelverwijzingen voor letters worden gedefinieerd met kleine letters. Als u een toetscombinatie wilt definiëren die een hoofdletter gebruikt, moet de toetscombinatie de Shift-toets bevatten. Bijvoorbeeld, Ctrl+Shift+x en Ctrl+x creëren verschillende bindingen.

Deze parameter accepteert een matrix met tekenreeksen. Elke tekenreeks is een afzonderlijke binding, geen reeks sleutels voor één binding.

Parametereigenschappen

Type:

String[]

Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Sleutelcode

Parametersets

(All)
Position:0
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Description

Hiermee geeft u een gedetailleerde beschrijving van de sleutelbinding die zichtbaar is in de uitvoer van de Get-PSReadLineKeyHandler cmdlet.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:LongDescription

Parametersets

ScriptBlock
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Function

Hiermee geeft u de naam op van een bestaande sleutelhandler die wordt geleverd door PSReadLine. Met deze parameter kunt u bestaande sleutelbindingen opnieuw koppelen of een handler binden die momenteel niet-afhankelijk is.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

Function
Position:1
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-ScriptBlock

Hiermee geeft u een scriptblokwaarde op die moet worden uitgevoerd wanneer de toetscombinatie wordt ingevoerd. PSReadLine geeft één of twee parameters door aan dit scriptblok. De eerste parameter is een ConsoleKeyInfo object dat de toets vertegenwoordigt die wordt ingedrukt. Het tweede argument kan elk object zijn, afhankelijk van de context.

Parametereigenschappen

Type:ScriptBlock
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

ScriptBlock
Position:1
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-ViMode

Geef op op welke vi-modus de binding van toepassing is.

Geldige waarden zijn:

  • Insert
  • Command

Parametereigenschappen

Type:ViMode
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

None

U kunt geen objecten doorsluisen naar deze cmdlet.

Uitvoerwaarden

None

Deze cmdlet retourneert geen uitvoer.