Set-PSReadLineKeyHandler

Modul:

PSReadLine Module

A kulcsokat felhasználó által definiált vagy PSReadLine kulcskezelő függvényekhez köti.

Syntax

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

A Set-PSReadLineKeyHandler parancsmag testre szabja az eredményt egy kulcs vagy billentyűsorozat lenyomásakor. A felhasználó által definiált kulcskötésekkel szinte bármit elvégezhet, ami egy PowerShell-szkriptből lehetséges.

Példák

1. példa: A nyílbillentyű kötése egy függvényhez

Ez a parancs a felfelé mutató nyílbillentyűt a HistorySearchBackward függvényhez köti. Ez a függvény a parancssor aktuális tartalmával kezdődő parancssorok parancselőzményeit keresi.

Set-PSReadLineKeyHandler -Chord UpArrow -Function HistorySearchBackward

2. példa: Kulcs kötése szkriptblokkhoz

Ez a példa bemutatja, hogyan használható egyetlen kulcs egy parancs futtatásához. A parancs egy szkriptblokkhoz köti a kulcsot Ctrl+b , amely törli a vonalat, beszúrja a "build" szót, majd elfogadja a sort.

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

Paraméterek

-BriefDescription

A kulcskötés rövid leírása. Ezt a leírást a Get-PSReadLineKeyHandler parancsmag jeleníti meg.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

ScriptBlock

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Chord

A függvényhez vagy szkriptblokkhoz kötve lévő kulcsok vagy kulcsok sorozata. Egyetlen karakterlánc használatával adjon meg egyetlen kötést. Ha a kötés kulcsok sorozata, vesszővel válassza el a kulcsokat. Például: Ctrl+x,Ctrl+l

A betűkulcs-hivatkozások kisbetűkkel vannak definiálva. Ha nagybetűs akkordot szeretne definiálni, az akkordnak tartalmaznia kell a Shift billentyűt. Például Ctrl+Shift+x és Ctrl+x különböző kötéseket hozhat létre.

Ez a paraméter sztringtömböt fogad el. Minden sztring egy külön kötés, nem pedig egyetlen kötés kulcssorozata.

Paramétertulajdonságok

Típus:	String[]
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False
Aliasok:	Billentyű

Paraméterkészletek

(All)

Position:	0
Kötelező:	True
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Description

A Get-PSReadLineKeyHandler parancsmag kimenetében látható kulcskötés részletesebb leírását adja meg.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False
Aliasok:	LongDescription

Paraméterkészletek

ScriptBlock

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Function

Megadja a PSReadLine által megadott meglévő kulcskezelő nevét. Ez a paraméter lehetővé teszi a meglévő kulcskötések újrakötését, vagy egy jelenleg kötetlen kezelő kötését.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

Function

Position:	1
Kötelező:	True
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-ScriptBlock

Az akkord megadásakor futtatandó szkriptblokk értékét adja meg. A PSReadLine egy vagy két paramétert ad át ehhez a szkriptblokkhoz. Az első paraméter egy ConsoleKeyInfo objektum, amely a lenyomott kulcsot jelöli. A második argumentum bármilyen objektum lehet a környezettől függően.

Paramétertulajdonságok

Típus:	ScriptBlock
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

ScriptBlock

Position:	1
Kötelező:	True
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-ViMode

Adja meg, hogy a kötés melyik vi módra vonatkozik.

Az érvényes értékek a következők:

• Insert
• Command

Paramétertulajdonságok

Típus:	ViMode
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Bevitelek

None

Ehhez a parancsmaghoz nem lehet objektumokat csövezni.

Kimenetek

None

Ez a parancsmag nem ad vissza kimenetet.

Kapcsolódó hivatkozások

• Get-PSReadLineKeyHandler
• Remove-PSReadLineKeyHandler
• Get-PSReadLineOption (PSReadLine beállításainak lekérése)
• Set-PSReadLineOption