Set-PSReadlineOption

Syntax

OptionsSet

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>]

ColorSet

Set-PSReadlineOption
    [-TokenKind] <TokenClassification>
    [[-ForegroundColor] <ConsoleColor>]
    [[-BackgroundColor] <ConsoleColor>]
    [<CommonParameters>]

Beschreibung

Beispiele

Beispiel 1: Festlegen von Vordergrund- und Hintergrundfarben

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

Beispiel 2: Festlegen des Glockenstils

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

Parameter

-AddToHistoryHandler

Gibt einen ScriptBlock an, der steuert, welche Befehle dem PSReadline-Verlauf hinzugefügt werden.

Die ScriptBlock- empfängt die Befehlszeile als Eingabe. Wenn das ScriptBlock-$Truezurückgibt, wird die Befehlszeile dem Verlauf hinzugefügt.

Parametereigenschaften

Parametersätze

-BackgroundColor

Gibt die Hintergrundfarbe für das vom TokenKind Parameter angegebene Token an.

Die zulässigen Werte für diesen Parameter sind wie folgt:

• Schwarz
• Dunkelblau
• Dunkelgrün
• DarkCyan
• Dunkelrot
• Dunkelmagenta
• DarkYellow
• Grau
• Dunkelgrau
• Blau
• Grün
• Zyan
• Rot
• Magenta
• Gelb
• Weiß

Parametereigenschaften

Parametersätze

-BellStyle

Gibt an, wie PSReadline auf verschiedene Fehler und mehrdeutige Bedingungen reagiert.

Die folgenden Werte sind gültig:

• Audible: Kurzer Signalton.
• Visuelle: Text blinkt kurz.
• Keine: Kein Feedback.

Parametereigenschaften

Parametersätze

-CommandValidationHandler

Gibt eine ScriptBlock- an, die von ValidateAndAcceptLineaufgerufen wird. Wenn eine Ausnahme ausgelöst wird, schlägt die Überprüfung fehl, und der Fehler wird gemeldet.

Vor dem Auslösen einer Ausnahme kann der Überprüfungshandler den Cursor an den Punkt des Fehlers setzen, um die Behebung zu vereinfachen. Ein Überprüfungshandler kann auch die Befehlszeile ändern, z. B. um häufige typografische Fehler zu beheben.

ValidateAndAcceptLine- wird verwendet, um zu vermeiden, dass Der Verlauf mit Befehlen, die nicht funktionieren können, überladen wird.

Parametereigenschaften

Parametersätze

-CompletionQueryItems

Gibt die maximale Anzahl von Abschlusselementen an, die ohne Aufforderung angezeigt werden.

Wenn die Anzahl der anzuzeigenden Elemente größer als dieser Wert ist, fordert PSReadline Ja /Nein auf, bevor die Fertigstellungselemente angezeigt werden.

Parametereigenschaften

Parametersätze

-ContinuationPrompt

Gibt die Zeichenfolge an, die am Anfang der nachfolgenden Zeilen angezeigt wird, wenn mehrzeilige Eingaben eingegeben werden. Der Standardwert ist doppelt größer als Zeichen (>>). Eine leere Zeichenfolge ist gültig.

Parametereigenschaften

Parametersätze

-ContinuationPromptBackgroundColor

Gibt die Hintergrundfarbe der Fortsetzungsaufforderung an.

Die zulässigen Werte entsprechen dem parameter BackgroundColor.

Parametereigenschaften

Parametersätze

-ContinuationPromptForegroundColor

Gibt die Vordergrundfarbe der Fortsetzungsaufforderung an.

Die zulässigen Werte entsprechen dem parameter BackgroundColor.

Parametereigenschaften

Parametersätze

-DingDuration

Gibt die Dauer des Signaltons an, wenn BellStyle- auf Audible-festgelegt ist.

Parametereigenschaften

Parametersätze

-DingTone

Gibt den Ton in Hertz (Hz) des Signaltons an, wenn BellStyle- auf Audible-festgelegt ist.

Parametereigenschaften

Parametersätze

-EditMode

Gibt den Befehlszeilenbearbeitungsmodus an. Mit diesem Parameter werden alle durch Set-PSReadlineKeyHandlerfestgelegten Tastenbindungen zurückgesetzt.

Die folgenden Werte sind gültig:

• Windows: Schlüsselbindungen emulieren PowerShell, cmd und Visual Studio.
• Emacs: Schlüsselbindungen emulieren Bash oder Emacs.
• Vi: Schlüsselbindungen emulieren Vi.

Parametereigenschaften

Parametersätze

-EmphasisBackgroundColor

Gibt die Hintergrundfarbe an, die zur Hervorhebung verwendet wird, z. B. zum Hervorheben von Suchtext.

Die zulässigen Werte entsprechen dem parameter BackgroundColor.

Parametereigenschaften

Parametersätze

-EmphasisForegroundColor

Gibt die Vordergrundfarbe an, die zur Hervorhebung verwendet wird, z. B. zum Hervorheben von Suchtext.

Die zulässigen Werte entsprechen dem parameter BackgroundColor.

Parametereigenschaften

Parametersätze

-ErrorBackgroundColor

Gibt die Hintergrundfarbe an, die für Fehler verwendet wird.

Die zulässigen Werte entsprechen dem parameter BackgroundColor.

Parametereigenschaften

Parametersätze

-ErrorForegroundColor

Gibt die Vordergrundfarbe an, die für Fehler verwendet wird.

Die zulässigen Werte entsprechen dem parameter BackgroundColor.

Parametereigenschaften

Parametersätze

-ExtraPromptLineCount

Gibt die Anzahl der zusätzlichen Zeilen an.

Wenn sich die Eingabeaufforderung über mehrere Zeilen erstreckt, geben Sie einen Wert für diesen Parameter an. Verwenden Sie diese Option, wenn Sie möchten, dass zusätzliche Zeilen verfügbar sind, wenn PSReadline die Eingabeaufforderung anzeigt, nachdem eine Ausgabe angezeigt wurde. PSReadline gibt z. B. eine Liste von Vervollständigungen zurück.

Diese Option wird weniger benötigt als in früheren Versionen von PSReadline, ist aber nützlich, wenn die InvokePrompt Funktion verwendet wird.

Parametereigenschaften

Parametersätze

-ForegroundColor

Gibt die Vordergrundfarbe für das Token an, das durch den parameter TokenKind angegeben wird.

Die zulässigen Werte entsprechen dem parameter BackgroundColor.

Parametereigenschaften

Parametersätze

-HistoryNoDuplicates

Diese Option steuert das Rückrufverhalten. Der Verlaufsdatei werden weiterhin doppelte Befehle hinzugefügt. Wenn diese Option festgelegt ist, wird beim Abrufen von Befehlen nur der letzte Aufruf angezeigt.

Wiederholte Befehle werden dem Verlauf hinzugefügt, um die Sortierung während des Rückrufs beizubehalten. Normalerweise möchten Sie den Befehl jedoch nicht mehrmals anzeigen, wenn Sie den Verlauf zurückrufen oder durchsuchen.

Parametereigenschaften

Parametersätze

-HistorySavePath

Gibt den Pfad zu der Datei an, in der der Verlauf gespeichert wird. Der Dateiname wird in einer Variablen $($host.Name)_history.txtgespeichert, z. B. ConsoleHost_history.txt.

Wenn Sie diesen Parameter nicht verwenden, lautet der Standardpfad wie folgt:

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

Parametereigenschaften

Parametersätze

-HistorySaveStyle

Gibt an, wie PSReadline den Verlauf speichert.

Gültige Werte sind wie folgt:

• SaveIncrementally: Speichern des Verlaufs, nachdem jeder Befehl ausgeführt und für mehrere Instanzen von PowerShell freigegeben wurde.
• SaveAtExit-: Anfügeverlaufsdatei beim Beenden von PowerShell.
• SaveNothing: Verwenden Sie keine Verlaufsdatei.

Parametereigenschaften

Parametersätze

-HistorySearchCaseSensitive

Gibt an, dass bei der Verlaufssuche die Groß-/Kleinschreibung in Funktionen wie ReverseSearchHistory oder HistorySearchBackward-berücksichtigt wird.

Parametereigenschaften

Parametersätze

-HistorySearchCursorMovesToEnd

Gibt an, dass der Cursor mithilfe einer Suche zum Ende der Befehle wechselt, die Sie aus dem Verlauf laden. Wenn dieser Parameter auf $Falsefestgelegt ist, verbleibt der Cursor an der Position, an der er war, als Sie die NACH-OBEN- oder NACH-UNTEN-TASTE gedrückt haben.

Um diese Option zu deaktivieren, können Sie einen der folgenden Befehle ausführen:

Set-PSReadlineOption -HistorySearchCursorMovesToEnd:$False

(Get-PSReadlineOption).HistorySearchCursorMovesToEnd = $False

Parametereigenschaften

Parametersätze

-MaximumHistoryCount

Gibt die maximale Anzahl von Befehlen an, die im PSReadline-Verlauf gespeichert werden sollen.

Der PSReadline-Verlauf ist vom PowerShell-Verlauf getrennt.

Parametereigenschaften

Parametersätze

-MaximumKillRingCount

Gibt die maximale Anzahl der im Kill-Ring gespeicherten Elemente an.

Parametereigenschaften

Parametersätze

-ResetTokenColors

Gibt an, dass mit diesem Cmdlet Tokenfarben auf Standardeinstellungen wiederhergestellt werden.

Parametereigenschaften

Parametersätze

-ShowToolTips

Wenn mögliche Fertigstellungen angezeigt werden, werden QuickInfos in der Liste der Fertigstellungen angezeigt.

Diese Option ist standardmäßig aktiviert. Diese Option war in früheren Versionen von PSReadline nicht standardmäßig aktiviert. Zum Deaktivieren legen Sie diese Option auf $Falsefest.

Parametereigenschaften

Parametersätze

-TokenKind

Gibt das Token an, wenn Sie Tokenfarboptionen mit den Parametern ForegroundColor und BackgroundColor festlegen.

Die zulässigen Werte für diesen Parameter sind wie folgt:

• Nichts
• Kommentar
• Schlüsselwort
• Schnur
• Bediener
• Variable
• Befehl
• Parameter
• Typ
• Nummer
• Mitglied

Parametereigenschaften

Parametersätze

-WordDelimiters

Gibt die Zeichen an, die Wörter für Funktionen wie ForwardWord- oder KillWord-trennen.

Parametereigenschaften

Parametersätze

CommonParameters

Eingaben

None

Ausgaben

None

Ähnliche Themen

• about_PSReadline
• Get-PSReadlineKeyHandler
• Get-PSReadlineOption
• Remove-PSReadlineKeyHandler
• Set-PSReadlineKeyHandler