Sdílet prostřednictvím

Set-PSReadLineKeyHandler

Modul:
PSReadLine Module

Vytvoří vazbu klíčů na uživatelem definované funkce nebo funkce obslužné rutiny klíčů PSReadLine.

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

Rutina Set-PSReadLineKeyHandler přizpůsobí výsledek při stisknutí klávesy nebo posloupnosti kláves. Pomocí uživatelem definovaných vazeb klíčů můžete v powershellovém skriptu udělat téměř cokoli, co je možné.

Příklady

Příklad 1: Vytvoření vazby šipkové klávesy k funkci

Tento příkaz sváže šipku nahoru s funkcí HistorySearchBackward. Tato funkce vyhledá historii příkazů pro příkazové řádky, které začínají aktuálním obsahem příkazového řádku.

Set-PSReadLineKeyHandler -Chord UpArrow -Function HistorySearchBackward

Příklad 2: Vytvoření vazby klíče k bloku skriptu

Tento příklad ukazuje, jak se dá použít jeden klíč ke spuštění příkazu. Příkaz vytvoří vazbu klíče Ctrl+B na blok skriptu, který vymaže řádek, vloží slovo "build" a pak přijme řádek.

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

Parametry

-BriefDescription

Stručný popis klíčové vazby. Tento popis se zobrazí rutinou Get-PSReadLineKeyHandler.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ScriptBlock
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Chord

Klíč nebo posloupnost klíčů, které mají být svázány s funkcí nebo blokem skriptu. K zadání jedné vazby použijte jeden řetězec. Pokud je vazba posloupností klíčů, oddělte klíče čárkou, jako v následujícím příkladu:

Ctrl+X,Ctrl+L

Poznámka:

Od PSReadLine 2.0.0 se v parametru Chordrozlišují malá a velká písmena. To znamená, že Ctrl+X a Ctrl+x vytvářejí různé vazby.

Tento parametr přijímá pole řetězců. Každý řetězec je samostatná vazba, nikoli posloupnost klíčů pro jednu vazbu.

Vlastnosti parametru

Typ:

String[]

Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Klíč

Sady parametrů

(All)
Position:0
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Description

Určuje podrobnější popis klíčové vazby, která je viditelná ve výstupu rutiny Get-PSReadLineKeyHandler.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:LongDescription

Sady parametrů

ScriptBlock
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Function

Určuje název existující obslužné rutiny klíče poskytované PSReadLine. Tento parametr umožňuje znovu připojit existující vazby klíčů nebo vytvořit vazbu obslužné rutiny, která je aktuálně nevázaná.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

Function
Position:1
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-ScriptBlock

Určuje hodnotu bloku skriptu, která se má spustit při zadání chordu. PsReadLine předává do tohoto bloku skriptu jeden nebo dva parametry. Prvním parametrem je ConsoleKeyInfo objekt představující stisknutou klávesu. Druhý argument může být libovolný objekt v závislosti na kontextu.

Vlastnosti parametru

Typ:ScriptBlock
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ScriptBlock
Position:1
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-ViMode

Určete režim vi, na který se vazba vztahuje.

Platné hodnoty jsou:

  • Insert
  • Command

Vlastnosti parametru

Typ:ViMode
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

None

Do této rutiny nelze vést objekty.

Výstupy

None

Tato rutina negeneruje žádný výstup.