Register-ArgumentCompleter

リファレンス

モジュール:: Microsoft.PowerShell.Core

カスタム引数の完了を登録します。

構文

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

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

説明

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

例

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

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

$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: タブ補完値に詳細を追加する

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

$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

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

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

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

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

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

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

Note

この dotnet complete コマンドは、バージョン 2.0 以降の 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

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

パラメーター

-CommandName

コマンドの名前を配列として指定します。

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

-Native

引数 completer が、PowerShell でパラメーター名を完了できないネイティブコマンド用であることを示します。

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

-ParameterName

引数が完了するパラメーターの名前を指定します。指定されたパラメーター名は、コマンドレットの ForegroundColor パラメーターなどの列挙値にWrite-Hostすることはできません。

列挙型の詳細については、「about_Enum」を参照してください。

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

-ScriptBlock

タブ補完を実行するために実行するコマンドを指定します。指定するスクリプトブロックは、入力を完了した値を返す必要があります。スクリプトブロックは、Where-Objectパイプライン (ForEach-Objectなど) または別の適切なメソッドを使用して値の登録を解除する必要があります。値の配列を返すと、PowerShell は配列全体を 1 つのタブ補完値として扱います。

スクリプトブロックは、次に示す順序で次のパラメーターを受け入れる必要があります。 PowerShell は位置によって値を渡すので、パラメーターの名前は重要ではありません。

$commandName (位置 0) - このパラメーターは、スクリプトブロックがタブ補完を提供するコマンドの名前に設定されます。
$parameterName (位置 1) - このパラメーターは、タブ補完が必要な値を持つパラメーターに設定されます。
$wordToComplete(位置 2) - このパラメーターは、ユーザーが Tab キーを押す前に指定した値に設定されます。スクリプトブロックでは、この値を使用してタブ補完値を決定する必要があります。
$commandAst (位置 3) - このパラメーターは、現在の入力行の抽象構文ツリー (AST) に設定されます。詳細については、「Ast クラス」を参照してください。
$fakeBoundParameters(位置 4) - このパラメーターは、ユーザーが Tab キーを押す$PSBoundParameters前に、コマンドレットを含むハッシュテーブルに設定されます。詳細については、about_Automatic_Variablesを参照してください。

Native パラメーターを指定する場合、スクリプトブロックは指定された順序で次のパラメーターを受け取る必要があります。 PowerShell は位置によって値を渡すので、パラメーターの名前は重要ではありません。

$wordToComplete(位置 0) - このパラメーターは、Tab キーを押す前にユーザーが指定した値に設定されます。スクリプトブロックでは、この値を使用してタブ補完値を決定する必要があります。
$commandAst (位置 1) - このパラメーターは、現在の入力行の抽象構文ツリー (AST) に設定されます。詳細については、「Ast クラス」を参照してください。
$cursorPosition(位置 2) - このパラメーターは、ユーザーが Tab キーを押したときにカーソルの位置に設定されます。

パラメーター属性として ArgumentCompleter を指定することもできます。詳細については、「about_Functions_Advanced_Parameters」を参照してください。

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

入力

None

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

出力