Dela via

Set-PSReadLineOption

  • Referens
Modul:
PSReadLine

Anpassar beteendet för kommandoradsredigering i PSReadLine.

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

Cmdleten Set-PSReadLineOption anpassar beteendet för modulen PSReadLine när du redigerar kommandoraden. Om du vill visa inställningarna för PSReadLine- använder du Get-PSReadLineOption.

Exempel

Exempel 1: Ange förgrunds- och bakgrundsfärger

I det här exemplet anges PSReadLine- för att visa token Kommentar med grön förgrundstext i en grå bakgrund.

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

Exempel 2: Ange klockformat

I det här exemplet svarar PSReadLine- på fel eller villkor som kräver användaruppmärksamhet. BellStyle- är inställd på att avge ett hörbart pip vid 1221 Hz för 60 ms.

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

Parametrar

-AddToHistoryHandler

Anger en ScriptBlock- som styr vilka kommandon som läggs till i PSReadLine- historik.

ScriptBlock- tar emot kommandoraden som indata. Om ScriptBlock- returnerar $Trueläggs kommandoraden till i historiken.

Typ:Func[String, Boolean]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-BackgroundColor

Anger bakgrundsfärgen för token som anges av parametern TokenKind.

Godkända värden för den här parametern är följande:

  • Svart
  • DarkBlue
  • DarkGreen
  • DarkCyan
  • DarkRed
  • DarkMagenta
  • DarkYellow
  • Grå
  • DarkGray
  • Blå
  • Grön
  • Cyan
  • Röd
  • Magenta
  • Gul
  • Vit
Typ:ConsoleColor
Godkända värden:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:2
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-BellStyle

Anger hur PSReadLine- svarar på olika fel och tvetydiga villkor.

De giltiga värdena är följande:

  • Hörbar: Ett kort pip.
  • Visual: Texten blinkar kort.
  • Ingen: Ingen feedback.
Typ:BellStyle
Godkända värden:None, Visual, Audible
Position:Named
Standardvärde:Audible
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-CommandValidationHandler

Anger en ScriptBlock- som anropas från ValidateAndAcceptLine. Om ett undantag utlöses misslyckas verifieringen och felet rapporteras.

Innan du utlöser ett undantag kan valideringshanteraren placera markören vid felpunkten för att göra det enklare att åtgärda. En valideringshanterare kan också ändra kommandoraden, till exempel för att korrigera vanliga typografiska fel.

ValidateAndAcceptLine används för att undvika att störa din historik med kommandon som inte kan fungera.

Typ:Action[CommandAst]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-CompletionQueryItems

Anger det maximala antalet slutförandeobjekt som visas utan att fråga.

Om antalet objekt som ska visas är större än det här värdet uppmanar PSReadLineja/nej- innan slutförandeobjekten visas.

Typ:Int32
Position:Named
Standardvärde:100
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ContinuationPrompt

Anger strängen som visas i början av efterföljande rader när indata för flera rader anges. Standardvärdet är dubbelt större än tecken (>>). En tom sträng är giltig.

Typ:String
Position:Named
Standardvärde:>>
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ContinuationPromptBackgroundColor

Anger bakgrundsfärgen för fortsättningsprompten.

De godtagbara värdena är samma som parametern BackgroundColor.

Typ:ConsoleColor
Godkända värden:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ContinuationPromptForegroundColor

Anger förgrundsfärgen för fortsättningsprompten.

De godtagbara värdena är samma som parametern BackgroundColor.

Typ:ConsoleColor
Godkända värden:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DingDuration

Anger varaktigheten för pipet när BellStyle- är inställd på Audible.

Typ:Int32
Position:Named
Standardvärde:50ms
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DingTone

Anger tonen i Hertz (Hz) i pipet när BellStyle- är inställd på Audible.

Typ:Int32
Position:Named
Standardvärde:1221
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-EditMode

Anger redigeringsläget för kommandoraden. Med den här parametern återställs alla nyckelbindningar som anges av Set-PSReadLineKeyHandler.

De giltiga värdena är följande:

  • Windows: Nyckelbindningar emulerar PowerShell, cmd och Visual Studio.
  • Emacs: Nyckelbindningar emulerar Bash eller Emacs.
  • Vi: Nyckelbindningar emulerar Vi.
Typ:EditMode
Godkända värden:Windows, Emacs, Vi
Position:Named
Standardvärde:Windows
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-EmphasisBackgroundColor

Anger bakgrundsfärgen som används för betoning, till exempel för att markera söktext.

De godtagbara värdena är samma som parametern BackgroundColor.

Typ:ConsoleColor
Godkända värden:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-EmphasisForegroundColor

Anger den förgrundsfärg som används för betoning, till exempel för att markera söktext.

De godtagbara värdena är samma som parametern BackgroundColor.

Typ:ConsoleColor
Godkända värden:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ErrorBackgroundColor

Anger bakgrundsfärgen som används för fel.

De godtagbara värdena är samma som parametern BackgroundColor.

Typ:ConsoleColor
Godkända värden:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ErrorForegroundColor

Anger förgrundsfärgen som används för fel.

De godtagbara värdena är samma som parametern BackgroundColor.

Typ:ConsoleColor
Godkända värden:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ExtraPromptLineCount

Anger antalet extra rader.

Om din fråga sträcker sig över mer än en rad anger du ett värde för den här parametern. Använd det här alternativet när du vill att extra rader ska vara tillgängliga när PSReadLine- visar kommandotolken efter att ha visat utdata. Till exempel returnerar PSReadLine en lista över slutföranden.

Det här alternativet behövs mindre än i tidigare versioner av PSReadLine, men är användbart när funktionen InvokePrompt används.

Typ:Int32
Position:Named
Standardvärde:0
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ForegroundColor

Anger förgrundsfärgen för den token som anges av parametern TokenKind.

De godtagbara värdena är samma som parametern BackgroundColor.

Typ:ConsoleColor
Godkända värden:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:1
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-HistoryNoDuplicates

Det här alternativet styr återkallningsbeteendet. Dubblettkommandon läggs fortfarande till i historikfilen. När det här alternativet har angetts visas endast det senaste anropet när kommandon återkallas.

Upprepade kommandon läggs till i historiken för att bevara ordningen under återkallandet. Du vill dock vanligtvis inte se kommandot flera gånger när du återkallar eller söker i historiken.

Typ:SwitchParameter
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-HistorySavePath

Anger sökvägen till filen där historiken sparas. Filnamnet lagras i en variabel $($host.Name)_history.txt, till exempel ConsoleHost_history.txt.

Om du inte använder den här parametern är standardsökvägen följande:

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

Typ:String
Position:Named
Standardvärde:$env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine\$($host.Name)_history.txt
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-HistorySaveStyle

Anger hur PSReadLine sparar historik.

Giltiga värden är följande:

  • SaveIncre mentalt: Spara historik efter att varje kommando har körts och dela över flera instanser av PowerShell.
  • SaveAtExit: Lägg till historikfil när PowerShell avslutas.
  • SaveNothing: Använd inte en historikfil.
Typ:HistorySaveStyle
Godkända värden:SaveIncrementally, SaveAtExit, SaveNothing
Position:Named
Standardvärde:SaveIncrementally
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-HistorySearchCaseSensitive

Anger att historiksökning är skiftlägeskänsligt i funktioner som ReverseSearchHistory eller HistorySearchBackward.

Typ:SwitchParameter
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-HistorySearchCursorMovesToEnd

Anger att markören flyttas till slutet av kommandon som du läser in från historiken med hjälp av en sökning. När den här parametern är inställd på $Falseförblir markören kvar på den position den var när du tryckte på uppåt- eller nedåtpilarna.

Om du vill inaktivera det här alternativet kan du köra något av följande kommandon:

Set-PSReadLineOption -HistorySearchCursorMovesToEnd:$False

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $False

Typ:SwitchParameter
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-MaximumHistoryCount

Anger det maximala antalet kommandon som ska sparas i PSReadLine historik.

PSReadLine-historiken är separat från PowerShell-historiken.

Typ:Int32
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-MaximumKillRingCount

Anger det maximala antalet objekt som lagras i dödsringen.

Typ:Int32
Position:Named
Standardvärde:10
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ResetTokenColors

Anger att den här cmdleten återställer tokenfärger till standardinställningarna.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ShowToolTips

När du visar möjliga slutföranden visas knappbeskrivningar i listan över slutföranden.

Det här alternativet är aktiverat som standard. Det här alternativet har inte aktiverats som standard i tidigare versioner av PSReadLine. Om du vill inaktivera anger du det här alternativet till $False.

Typ:SwitchParameter
Position:Named
Standardvärde:True
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-TokenKind

Anger token när du anger färgalternativ för token med parametrarna ForegroundColor och BackgroundColor.

Godkända värden för den här parametern är följande:

  • Ingen
  • Kommentar
  • Nyckelord
  • Sträng
  • Operatör
  • Variabel
  • Befallning
  • Parameter
  • Typ
  • Nummer
  • Medlem
Typ:TokenClassification
Godkända värden:None, Comment, Keyword, String, Operator, Variable, Command, Parameter, Type, Number, Member
Position:0
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-WordDelimiters

Anger de tecken som avgränsar ord för funktioner som ForwardWord eller KillWord.

Typ:String
Position:Named
Standardvärde:;:,.[]{}()/\|^&*-=+-—―
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

None

Du kan inte skicka objekt i pipelinen till Set-PSReadLineOption.

Utdata

None

Set-PSReadLineOption genererar inte utdata.