Delen via

Set-PSReadLineOption

  • Referentie
Module:
PSReadLine

Hiermee past u het gedrag van het bewerken van de opdrachtregel in PSReadLine aan.

Syntax

Set-PSReadLineOption
   [-EditMode <EditMode>]
   [-ContinuationPrompt <String>]
   [-ContinuationPromptForegroundColor <ConsoleColor>]
   [-ContinuationPromptBackgroundColor <ConsoleColor>]
   [-EmphasisForegroundColor <ConsoleColor>]
   [-EmphasisBackgroundColor <ConsoleColor>]
   [-ErrorForegroundColor <ConsoleColor>]
   [-ErrorBackgroundColor <ConsoleColor>]
   [-HistoryNoDuplicates]
   [-AddToHistoryHandler <Func[string,bool]>]
   [-CommandValidationHandler <Action[CommandAst]>]
   [-HistorySearchCursorMovesToEnd]
   [-MaximumHistoryCount <Int32>]
   [-MaximumKillRingCount <Int32>]
   [-ResetTokenColors]
   [-ShowToolTips]
   [-ExtraPromptLineCount <Int32>]
   [-DingTone <Int32>]
   [-DingDuration <Int32>]
   [-BellStyle <BellStyle>]
   [-CompletionQueryItems <Int32>]
   [-WordDelimiters <String>]
   [-HistorySearchCaseSensitive]
   [-HistorySaveStyle <HistorySaveStyle>]
   [-HistorySavePath <String>]
   [<CommonParameters>]
Set-PSReadLineOption
   [-TokenKind] <TokenClassification>
   [[-ForegroundColor] <ConsoleColor>]
   [[-BackgroundColor] <ConsoleColor>]
   [<CommonParameters>]

Description

De Set-PSReadLineOption cmdlet past het gedrag van de PSReadLine-module aan wanneer u de opdrachtregel bewerkt. Als u de INSTELLINGEN van PSReadLine wilt weergeven, gebruikt u Get-PSReadLineOption.

Voorbeelden

Voorbeeld 1: voorgrond- en achtergrondkleuren instellen

In dit voorbeeld wordt PSReadLine ingesteld om het token Opmerking weer te geven met groene voorgrondtekst op een grijze achtergrond.

Set-PSReadLineOption -TokenKind Comment -ForegroundColor Green -BackgroundColor Gray

Voorbeeld 2: Belstijl instellen

In dit voorbeeld reageert PSReadLine op fouten of voorwaarden die de aandacht van de gebruiker vereisen. De BellStyle is ingesteld op het uitzenden van een hoorbare pieptoon bij 1221 Hz gedurende 60 ms.

Set-PSReadLineOption -BellStyle Audible -DingTone 1221 -DingDuration 60

Parameters

-AddToHistoryHandler

Hiermee geeft u een ScriptBlock waarmee wordt bepaald welke opdrachten worden toegevoegd aan DE GESCHIEDENIS van PSReadLine .

Het ScriptBlock ontvangt de opdrachtregel als invoer. Als ScriptBlock retourneert $True, wordt de opdrachtregel toegevoegd aan de geschiedenis.

Type:Func[String, Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BackgroundColor

Hiermee geeft u de achtergrondkleur voor het token dat is opgegeven door de tokenKind parameter.

De acceptabele waarden voor deze parameter zijn als volgt:

  • Zwart
  • DonkerBlauw
  • Donkergroen
  • DonkerCyan
  • Donkerroeid
  • DarkMagenta
  • DonkerYellow
  • Grijs
  • DarkGray
  • Blue
  • Green
  • Cyaan
  • Red
  • Magenta
  • Geel
  • Wit
Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BellStyle

Hiermee geeft u op hoe PSReadLine reageert op verschillende fouten en dubbelzinnige voorwaarden.

De geldige waarden zijn als volgt:

  • Hoorbaar: Een korte pieptoon.
  • Visual: Tekst knippert kort.
  • Geen: geen feedback.
Type:BellStyle
Accepted values:None, Visual, Audible
Position:Named
Default value:Audible
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CommandValidationHandler

Hiermee geeft u een ScriptBlock dat wordt aangeroepen vanuit ValidateAndAcceptLine. Als er een uitzondering wordt gegenereerd, mislukt de validatie en wordt de fout gerapporteerd.

Voordat een uitzondering wordt gegenereerd, kan de validatiehandler de cursor op het punt van de fout plaatsen, zodat deze gemakkelijker kan worden opgelost. Een validatie-handler kan ook de opdrachtregel wijzigen, bijvoorbeeld om veelvoorkomende typografische fouten te corrigeren.

ValidateAndAcceptLine wordt gebruikt om te voorkomen dat uw geschiedenis rommelig wordt met opdrachten die niet werken.

Type:Action[CommandAst]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CompletionQueryItems

Hiermee geeft u het maximum aantal voltooiingsitems op dat wordt weergegeven zonder te vragen.

Als het aantal weer te geven items groter is dan deze waarde, vraagt PSReadLineja/nee voordat de voltooiingsitems worden weergegeven.

Type:Int32
Position:Named
Default value:100
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContinuationPrompt

Hiermee geeft u de tekenreeks op die wordt weergegeven aan het begin van de volgende regels wanneer invoer met meerdere regels wordt ingevoerd. De standaardwaarde is dubbele groter-dan-tekens (>>). Een lege tekenreeks is geldig.

Type:String
Position:Named
Default value:>>
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContinuationPromptBackgroundColor

Hiermee geeft u de achtergrondkleur van de vervolgprompt op.

De acceptabele waarden zijn hetzelfde als de parameter BackgroundColor .

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContinuationPromptForegroundColor

Hiermee geeft u de voorgrondkleur van de vervolgprompt op.

De acceptabele waarden zijn hetzelfde als de parameter BackgroundColor .

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DingDuration

Hiermee geeft u de duur van de pieptoon wanneer BellStyle is ingesteld op Audible.

Type:Int32
Position:Named
Default value:50ms
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DingTone

Hiermee geeft u de toon in Hertz (Hz) van de pieptoon wanneer BellStyle is ingesteld op Audible.

Type:Int32
Position:Named
Default value:1221
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EditMode

Hiermee geeft u de bewerkingsmodus van de opdrachtregel op. Met deze parameter worden alle sleutelbindingen die zijn ingesteld door opnieuw ingesteld door Set-PSReadLineKeyHandler.

De geldige waarden zijn als volgt:

  • Windows: sleutelbindingen emuleren PowerShell, cmd en Visual Studio.
  • Emacs: sleutelbindingen emuleren Bash of Emacs.
  • Vi: Sleutelbindingen emuleren Vi.
Type:EditMode
Accepted values:Windows, Emacs, Vi
Position:Named
Default value:Windows
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EmphasisBackgroundColor

Hiermee geeft u de achtergrondkleur op die wordt gebruikt voor nadruk, bijvoorbeeld om zoektekst te markeren.

De acceptabele waarden zijn hetzelfde als de parameter BackgroundColor .

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EmphasisForegroundColor

Hiermee geeft u de voorgrondkleur op die wordt gebruikt voor nadruk, bijvoorbeeld om zoektekst te markeren.

De acceptabele waarden zijn hetzelfde als de parameter BackgroundColor .

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ErrorBackgroundColor

Hiermee geeft u de achtergrondkleur op die wordt gebruikt voor fouten.

De acceptabele waarden zijn hetzelfde als de parameter BackgroundColor .

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ErrorForegroundColor

Hiermee geeft u de voorgrondkleur op die wordt gebruikt voor fouten.

De acceptabele waarden zijn hetzelfde als de parameter BackgroundColor .

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExtraPromptLineCount

Hiermee geeft u het aantal extra regels op.

Als de prompt meer dan één regel omvat, geeft u een waarde op voor deze parameter. Gebruik deze optie als u extra regels beschikbaar wilt maken wanneer PSReadLine de prompt weergeeft na het weergeven van uitvoer. PSReadLine retourneert bijvoorbeeld een lijst met voltooiingen.

Deze optie is minder nodig dan in eerdere versies van PSReadLine, maar is handig wanneer de InvokePrompt functie wordt gebruikt.

Type:Int32
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForegroundColor

Hiermee geeft u de voorgrondkleur op voor het token dat is opgegeven door de parameter TokenKind .

De acceptabele waarden zijn hetzelfde als de parameter BackgroundColor .

Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HistoryNoDuplicates

Met deze optie bepaalt u het intrekkingsgedrag. Dubbele opdrachten worden nog steeds toegevoegd aan het geschiedenisbestand. Wanneer deze optie is ingesteld, wordt alleen de meest recente aanroep weergegeven bij het intrekken van opdrachten.

Herhaalde opdrachten worden toegevoegd aan de geschiedenis om de volgorde tijdens het intrekken te behouden. Meestal wilt u de opdracht echter niet meerdere keren zien wanneer u de geschiedenis inroept of doorzoekt.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HistorySavePath

Hiermee geeft u het pad naar het bestand waar de geschiedenis wordt opgeslagen. De bestandsnaam wordt opgeslagen in een variabele $($host.Name)_history.txt, bijvoorbeeld ConsoleHost_history.txt.

Als u deze parameter niet gebruikt, is het standaardpad als volgt:

$env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine\$($host.Name)_history.txt

Type:String
Position:Named
Default value:$env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine\$($host.Name)_history.txt
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HistorySaveStyle

Hiermee geeft u op hoe PSReadLine de geschiedenis opslaat.

Geldige waarden zijn als volgt:

  • OpslaanIncrementally: sla de geschiedenis op nadat elke opdracht is uitgevoerd en deel deze over meerdere exemplaren van PowerShell.
  • SaveAtExit: toevoeggeschiedenisbestand wanneer PowerShell wordt afgesloten.
  • OpslaanNothing: gebruik geen geschiedenisbestand.
Type:HistorySaveStyle
Accepted values:SaveIncrementally, SaveAtExit, SaveNothing
Position:Named
Default value:SaveIncrementally
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HistorySearchCaseSensitive

Hiermee geeft u op dat het zoeken naar geschiedenis hoofdlettergevoelig is in functies zoals ReverseSearchHistory of HistorySearchBackward.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HistorySearchCursorMovesToEnd

Geeft aan dat de cursor wordt verplaatst naar het einde van opdrachten die u uit de geschiedenis laadt met behulp van een zoekopdracht. Wanneer deze parameter is ingesteld op $False, blijft de cursor op de positie die deze was toen u de pijl-omhoog of pijl-omlaag indrukte.

Als u deze optie wilt uitschakelen, kunt u een van de volgende opdrachten uitvoeren:

Set-PSReadLineOption -HistorySearchCursorMovesToEnd:$False

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $False

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaximumHistoryCount

Hiermee geeft u het maximum aantal opdrachten op dat moet worden opgeslagen in de PSReadLine-geschiedenis .

De geschiedenis van PSReadLine staat los van de PowerShell-geschiedenis.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaximumKillRingCount

Hiermee geeft u het maximum aantal items op dat is opgeslagen in de kill ring.

Type:Int32
Position:Named
Default value:10
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResetTokenColors

Geeft aan dat deze cmdlet tokenkleuren herstelt naar de standaardinstellingen.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ShowToolTips

Bij het weergeven van mogelijke voltooiingen worden knopinfo weergegeven in de lijst met voltooiingen.

Deze optie is standaard ingeschakeld. Deze optie is niet standaard ingeschakeld in eerdere versies van PSReadLine. Als u wilt uitschakelen, stelt u deze optie in op $False.

Type:SwitchParameter
Position:Named
Default value:True
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TokenKind

Hiermee geeft u het token wanneer u tokenkleuropties instelt met de parameters ForegroundColor en BackgroundColor .

De acceptabele waarden voor deze parameter zijn als volgt:

  • Geen
  • Opmerking
  • Trefwoord
  • Tekenreeks
  • Operator
  • Variabele
  • Opdracht
  • Parameter
  • Type
  • Aantal
  • Lid
Type:TokenClassification
Accepted values:None, Comment, Keyword, String, Operator, Variable, Command, Parameter, Type, Number, Member
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WordDelimiters

Hiermee geeft u de tekens op die woorden scheiden voor functies zoals ForwardWord of KillWord.

Type:String
Position:Named
Default value:;:,.[]{}()/\|^&*-=+-—―
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Invoerwaarden

None

U kunt geen objecten in de pijplijn verzenden naar Set-PSReadLineOption.

Uitvoerwaarden

None

Set-PSReadLineOption genereert geen uitvoer.