次の方法で共有

TabExpansion2

  • リファレンス
モジュール:
Microsoft.PowerShell.Core

PowerShell スクリプトのタブ補完をCompleteInput()提供するために CommandCompletion クラスのメソッドをラップするヘルパー関数。

構文

TabExpansion2
   [-inputScript] <String>
   [[-cursorColumn] <Int32>]
   [[-options] <Hashtable>]
   [<CommonParameters>]
TabExpansion2
   [-ast] <Ast>
   [-tokens] <Token[]>
   [-positionOfCursor] <IScriptPosition>
   [[-options] <Hashtable>]
   [<CommonParameters>]

説明

TabExpansion2 は、ユーザー入力のタブ補完を提供する組み込み関数です。 PowerShell は、ユーザーがコマンドの入力中に Tab キーまたは Ctrl+Space キーを押すと、この関数を呼び出します。 この関数は、現在の入力で可能な入力候補の一覧を返します。

TabExpansion2 は通常、ユーザーが直接呼び出すわけではありません。 ただし、タブ補完のテストに役立ちます。 使用 TabExpansion2するには、現在の入力スクリプトとスクリプト内のカーソル位置を指定する必要があります。 この関数は、現在の入力で 可能な入力候補の一覧を含む CommandCompletion オブジェクトを返します。 この入力スクリプトには、スクリプトを表す文字列または抽象構文ツリー (AST) を指定できます。

PowerShell セッションで同じ名前のカスタム関数を定義することで、既定の TabExpansion2 動作をオーバーライドできます。 このカスタム関数は、カスタム コマンドまたはパラメーターの入力候補を提供できます。 オーバーライド TabExpansion2は可能ですが、サポートされていません。 タブ補完動作をカスタマイズする必要がある場合にのみ、カスタム関数を作成する必要があります。

例

例 1 - コマンド パラメーターのタブ補完を取得する

この例では、PowerShell コマンド プロンプトで入力すると Format-Hex -<Tab> 得られるのと同じ結果が表示されます。 この関数は TabExpansion2 、トークンの 入力候補の一覧を含む CommandCompletion オブジェクトを - 返します。

TabExpansion2 -inputScript ($s = 'Format-Hex -') -cursorColumn $s.Length |
    Select-Object -ExpandProperty CompletionMatches

CompletionText ListItemText    ResultType ToolTip
-------------- ------------    ---------- -------
-Path          Path         ParameterName [string[]] Path
-LiteralPath   LiteralPath  ParameterName [string[]] LiteralPath
-InputObject   InputObject  ParameterName [psobject] InputObject
-Encoding      Encoding     ParameterName [Encoding] Encoding
-Count         Count        ParameterName [long] Count
-Offset        Offset       ParameterName [long] Offset

例 2 - パラメーター値のタブ補完を取得する

この例では、パラメーター値のタブ補完を取得する方法を示します。 この例では、Stage パラメーターには 3 つの可能な値があり、値の 1 つが Three. この手法を使用して、関数のタブ補完によって期待される結果が返されることをテストできます。

function GetData {
    param (
        [ValidateSet('One', 'Two', 'Three')]
        [string]$Stage
    )
    Write-Verbose "Retrieving data for stage $Stage"
}

$result = TabExpansion2 -inputScript ($line = 'GetData -Stage ') -cursorColumn $line.Length |
    Select-Object -ExpandProperty CompletionMatches
$result.Count -eq 3
$result.CompletionText -contains 'Three'

True
True

パラメーター

-ast

タブ補完を使用して展開するスクリプトを表す抽象構文ツリー (AST) オブジェクト。

型:Ast
Position:0
既定値:None
必須:True
Accept pipeline input:False
Accept wildcard characters:False

-cursorColumn

入力スクリプト文字列内のカーソルの列番号。 カーソル位置は、タブ補完によって展開されるトークンを決定するために使用されます。

型:Int32
Position:1
既定値:None
必須:False
Accept pipeline input:False
Accept wildcard characters:False

-inputScript

タブ補完を使用して展開するスクリプトを表す文字列。

型:String
Position:0
既定値:None
必須:True
Accept pipeline input:False
Accept wildcard characters:False

-options

API に渡すオプション値の CompleteInput() ハッシュテーブル。 API は、次のブール値オプションを受け入れます。

  • IgnoreHiddenShares- に$true設定すると、非表示の UNC 共有 (.\\COMPUTER\C$. など\\COMPUTER\ADMIN$) は無視されます。 既定では、PowerShell には非表示の共有が含まれています。
  • RelativePaths - 既定では、指定した入力に基づいてパスを展開する方法が PowerShell によって決定されます。 この値を設定すると、 $true PowerShell でパスが相対パスに置き換えられます。 この値を設定すると $false、PowerShell で絶対パスに置き換えられます。
  • LiteralPaths - 既定では、PowerShell は角かっこやバックティックなどの特殊なファイル文字を、エスケープされた同等の文字に置き換えます。 この値を設定すると $true 、置き換えができなくなります。
型:Hashtable
Position:3
既定値:None
必須:False
Accept pipeline input:False
Accept wildcard characters:False

-positionOfCursor

入力 AST 内のカーソルの列番号。 カーソル位置は、タブ補完によって展開されるトークンを決定するために使用されます。

型:IScriptPosition
Position:2
既定値:None
必須:True
Accept pipeline input:False
Accept wildcard characters:False

-tokens

入力スクリプトから解析されたトークンの配列。 トークンは、タブ補完によって展開されるトークンを決定するために使用されます。

型:Token[]
Position:1
既定値:None
必須:True
Accept pipeline input:False
Accept wildcard characters:False

入力

None

出力

CommandCompletion