Set-PSReadlineOption

構文

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

説明

例

例 1: 前景色と背景色を設定する

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

例 2: ベル スタイルを設定する

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

パラメーター

-AddToHistoryHandler

PSReadline の履歴に追加するコマンドを制御する ScriptBlock を指定します。

ScriptBlock は、コマンド ラインを入力として受け取ります。 ScriptBlock が $Trueを返した場合、コマンド ラインが履歴に追加されます。

パラメーターのプロパティ

パラメーター セット

-BackgroundColor

TokenKind パラメーターで指定されたトークンの背景色を指定します。

このパラメーターに使用できる値は次のとおりです。

• 黒い
• DarkBlue
• ダークグリーン
• ダークシアン (DarkCyan)
• ダークレッド
• ダークマゼンタ
• DarkYellow
• 灰色
• DarkGray
• 青い
• 緑色
• シアン
• 赤い
• マジェンタ
• 黄色
• 白い

パラメーターのプロパティ

パラメーター セット

-BellStyle

PSReadline がさまざまなエラーやあいまいな条件にどのように応答するかを指定します。

有効な値は次のとおりです。

• 可聴:短いビープ音。
• ビジュアル: テキストが短時間点滅します。
• なし: フィードバックはありません。

パラメーターのプロパティ

パラメーター セット

-CommandValidationHandler

ValidateAndAcceptLineから呼び出される ScriptBlock 指定します。 例外がスローされた場合、検証は失敗し、エラーが報告されます。

例外をスローする前に、検証ハンドラーはエラーの時点にカーソルを置いて、修正を容易にすることができます。 検証ハンドラーは、一般的な文字体裁エラーを修正するなど、コマンド ラインを変更することもできます。

ValidateAndAcceptLine は、機能しないコマンドで履歴が乱雑にならないようにするために使用されます。

パラメーターのプロパティ

パラメーター セット

-CompletionQueryItems

プロンプトなしで表示される完了項目の最大数を指定します。

表示する項目の数がこの値より大きい場合、 PSReadline は完了項目を表示する前に yes/no を求めます。

パラメーターのプロパティ

パラメーター セット

-ContinuationPrompt

複数行の入力が入力されたときに、後続の行の先頭に表示される文字列を指定します。 既定値は、二重より大きい記号 (>>) です。 空の文字列が有効です。

パラメーターのプロパティ

パラメーター セット

-ContinuationPromptBackgroundColor

継続プロンプトの背景色を指定します。

使用できる値は、BackgroundColor パラメーターと同じです。

パラメーターのプロパティ

パラメーター セット

-ContinuationPromptForegroundColor

継続プロンプトの前景色を指定します。

使用できる値は、BackgroundColor パラメーターと同じです。

パラメーターのプロパティ

パラメーター セット

-DingDuration

BellStyle を [可聴に設定 場合のビープ音の継続時間を指定します。

パラメーターのプロパティ

パラメーター セット

-DingTone

BellStyle が可聴に設定されている場合 ビープ音のヘルツ (Hz) のトーン 指定します。

パラメーターのプロパティ

パラメーター セット

-EditMode

コマンド ライン編集モードを指定します。 このパラメーターを使用すると、Set-PSReadlineKeyHandlerによって設定されたすべてのキー バインドがリセットされます。

有効な値は次のとおりです。

• Windows: キー バインドは、PowerShell、cmd、および Visual Studio をエミュレートします。
• Emacs: キー バインディングは Bash または Emacs をエミュレートします。
• Vi: キー バインドは Vi をエミュレートします。

パラメーターのプロパティ

パラメーター セット

-EmphasisBackgroundColor

検索テキストを強調表示するなど、強調に使用する背景色を指定します。

使用できる値は、BackgroundColor パラメーターと同じです。

パラメーターのプロパティ

パラメーター セット

-EmphasisForegroundColor

検索テキストを強調表示するなど、強調に使用する前景色を指定します。

使用できる値は、BackgroundColor パラメーターと同じです。

パラメーターのプロパティ

パラメーター セット

-ErrorBackgroundColor

エラーに使用される背景色を指定します。

使用できる値は、BackgroundColor パラメーターと同じです。

パラメーターのプロパティ

パラメーター セット

-ErrorForegroundColor

エラーに使用される前景色を指定します。

使用できる値は、BackgroundColor パラメーターと同じです。

パラメーターのプロパティ

パラメーター セット

-ExtraPromptLineCount

余分な行の数を指定します。

プロンプトが複数行にまたがる場合は、このパラメーターの値を指定します。 このオプションは、出力を表示した後に PSReadline がプロンプトを表示するときに追加の行を使用できるようにする場合に使用します。 たとえば、 PSReadline は入力候補の一覧を返します。

このオプションは、 以前のバージョンの PSReadline よりも必要が少なくなっていますが、 InvokePrompt 関数を使用する場合に便利です。

パラメーターのプロパティ

パラメーター セット

-ForegroundColor

TokenKind パラメーターで指定されたトークンの前景色を指定します。

使用できる値は、BackgroundColor パラメーターと同じです。

パラメーターのプロパティ

パラメーター セット

-HistoryNoDuplicates

このオプションは、取り消し動作を制御します。 重複するコマンドは履歴ファイルに引き続き追加されます。 このオプションを設定すると、コマンドを呼び出すときに最新の呼び出しのみが表示されます。

繰り返しコマンドが履歴に追加され、呼び戻し中の順序が保持されます。 ただし、通常、履歴を呼び出したり検索したりするときに、コマンドを複数回表示する必要はありません。

パラメーターのプロパティ

パラメーター セット

-HistorySavePath

履歴を保存するファイルへのパスを指定します。 ファイル名は、$($host.Name)_history.txtなどの変数 ConsoleHost_history.txtに格納されます。

このパラメーターを使用しない場合、既定のパスは次のようになります。

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

パラメーターのプロパティ

パラメーター セット

-HistorySaveStyle

PSReadline が履歴を保存する方法を指定します。

有効な値は次のとおりです。

• SaveIncrementally: 各コマンドの実行後に履歴を保存し、PowerShell の複数のインスタンス間で共有します。
• SaveAtExit: PowerShell の終了時に履歴ファイルを追加します。
• SaveNothing: 履歴ファイルを使用しないでください。

パラメーターのプロパティ

パラメーター セット

-HistorySearchCaseSensitive

reverseSearchHistory や HistorySearchBackwardなどの関数では、履歴検索で大文字と小文字が区別されることを指定します。

パラメーターのプロパティ

パラメーター セット

-HistorySearchCursorMovesToEnd

検索を使用して履歴から読み込むコマンドの末尾にカーソルが移動することを示します。 このパラメーターを $Falseに設定すると、カーソルは上矢印または下矢印を押したときの位置に残ります。

このオプションをオフにするには、次のいずれかのコマンドを実行します。

Set-PSReadlineOption -HistorySearchCursorMovesToEnd:$False

(Get-PSReadlineOption).HistorySearchCursorMovesToEnd = $False

パラメーターのプロパティ

パラメーター セット

-MaximumHistoryCount

PSReadline 履歴に保存するコマンドの最大数を指定します。

PSReadline の履歴は、PowerShell の履歴とは別のものです。

パラメーターのプロパティ

パラメーター セット

-MaximumKillRingCount

キル リングに格納されるアイテムの最大数を指定します。

パラメーターのプロパティ

パラメーター セット

-ResetTokenColors

このコマンドレットがトークンの色を既定の設定に復元することを示します。

パラメーターのプロパティ

パラメーター セット

-ShowToolTips

可能な入力候補を表示すると、入力候補の一覧にヒントが表示されます。

このオプションは既定で有効になっています。 このオプションは、以前のバージョンの PSReadline では既定で有効になっていませんでした。 無効にするには、このオプションを $Falseに設定します。

パラメーターのプロパティ

パラメーター セット

-TokenKind

ForegroundColor と BackgroundColor パラメーターを使用してトークンの色オプションを設定するときにトークン 指定します。

このパラメーターに使用できる値は次のとおりです。

• 無し
• コメント
• キーワード
• 糸
• オペレーター
• 変数
• コマンド
• パラメーター
• タイプ
• 番号
• メンバー

パラメーターのプロパティ

パラメーター セット

-WordDelimiters

ForwardWord や KillWordなどの関数の単語を区切る文字を指定します。

パラメーターのプロパティ

パラメーター セット

CommonParameters

入力

None

出力

None

関連リンク

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