Register-ArgumentCompleter

構文

Register-ArgumentCompleter
        -CommandName <String[]>
        -ScriptBlock <ScriptBlock>
        [-Native]
        [<CommonParameters>]

Register-ArgumentCompleter
        [-CommandName <String[]>]
        -ParameterName <String>
        -ScriptBlock <ScriptBlock>
        [<CommonParameters>]

説明

Register-ArgumentCompleter コマンドレットは、カスタム引数の完了を登録します。 引数の完了機能を使用すると、指定した任意のコマンドに対して実行時に動的タブ補完を提供できます。

例

例 1: カスタム引数の完了を登録する

次の例では、Set-TimeZone コマンドレットの Id パラメーターの引数 completer を登録します。

$scriptBlock = {
    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters)

    (Get-TimeZone -ListAvailable).Id | Where-Object {
        $_ -like "$wordToComplete*"
    } | ForEach-Object {
          "'$_'"
    }
}
Register-ArgumentCompleter -CommandName Set-TimeZone -ParameterName Id -ScriptBlock $scriptBlock

最初のコマンドは、ユーザーが Tab を押したときに渡される必要なパラメーターを受け取るスクリプト ブロックを作成します。詳細については、 ScriptBlock パラメーターの説明を参照してください。

スクリプト ブロック内で、 Id の使用可能な値は、 Get-TimeZone コマンドレットを使用して取得されます。 各タイム ゾーンの Id プロパティは、 Where-Object コマンドレットにパイプ処理されます。 Where-Object コマンドレットは、ユーザーが Tab を押す前に入力したテキストを表す、$wordToCompleteによって指定された値で始まる ID を除外します。フィルター処理された ID は、値にスペースが含まれている場合に、各値を引用符で囲むForEach-Object コマンドレットにパイプされます。

2 番目のコマンドは、scriptblock、 ParameterName Id 、および CommandName Set-TimeZone を渡すことによって、引数の完了を登録します。

例 2: タブ補完値に詳細を追加する

次の例では、Stop-Service コマンドレットの Name パラメーターのタブ補完を上書きし、実行中のサービスのみを返します。

$s = {
    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters)
    $services = Get-Service | Where-Object {$_.Status -eq "Running" -and $_.Name -like "$wordToComplete*"}
    $services | ForEach-Object {
        New-Object -Type System.Management.Automation.CompletionResult -ArgumentList $_.Name,
            $_.Name,
            "ParameterValue",
            $_.Name
    }
}
Register-ArgumentCompleter -CommandName Stop-Service -ParameterName Name -ScriptBlock $s

最初のコマンドは、ユーザーが Tab を押したときに渡される必要なパラメーターを受け取るスクリプト ブロックを作成します。詳細については、 ScriptBlock パラメーターの説明を参照してください。

スクリプト ブロック内で、最初のコマンドは、 Where-Object コマンドレットを使用して実行中のすべてのサービスを取得します。 サービスは、 ForEach-Object コマンドレットにパイプされます。 ForEach-Object コマンドレットは、新しい System.Management.Automation.CompletionResult オブジェクトを作成し、現在のサービスの名前を設定します (パイプライン変数$_.Nameで表されます)。

CompletionResult オブジェクトを使用すると、返される各値に追加の詳細を指定できます。

• completionText (String) - オートコンプリートの結果として使用するテキスト。 これは、コマンドに送信される値です。
• listItemText (String) - ユーザーが Ctrl+Space を押したときなど、リストに表示されるテキスト。 これは表示にのみ使用され、選択した場合はコマンドに渡されません。
• resultType (CompletionResultType) - 完了結果の種類。
• toolTip (文字列) - オブジェクトに関する詳細が表示されるヒントのテキスト。 これは、ユーザーが Ctrl+Space キーを押した後項目を選択したときに表示されます。

最後のコマンドは、停止したサービスを引き続き手動で Stop-Service コマンドレットに渡すことができることを示しています。 影響を受けるのはタブ補完だけです。

例 3: カスタムネイティブ引数のコンプリートを登録する

Native パラメーターを使用して、ネイティブ コマンドのタブ補完を指定できます。 次の例では、 dotnet コマンド ライン インターフェイス (CLI) のタブ補完を追加します。

$scriptblock = {
    param($wordToComplete, $commandAst, $cursorPosition)
        dotnet complete --position $cursorPosition $commandAst.ToString() | ForEach-Object {
            [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
        }
}
Register-ArgumentCompleter -Native -CommandName dotnet -ScriptBlock $scriptblock

最初のコマンドは、ユーザーが Tab を押したときに渡される必要なパラメーターを受け取るスクリプト ブロックを作成します。詳細については、 ScriptBlock パラメーターの説明を参照してください。

スクリプト ブロック内では、 dotnet complete コマンドを使用してタブ補完を実行します。 結果は、ForEach-Object コマンドレットにパイプ処理され、System.Management.Automation.CompletionResult クラスの new 静的メソッドを使用して、値ごとに新しい CompletionResult オブジェクトが作成されます。

パラメーター

-CommandName

-Native

-ParameterName

-ScriptBlock

入力

None

このコマンドレットにオブジェクトをパイプすることはできません。

出力

None

このコマンドレットは、出力を返しません。