TabExpansion2

TabExpansion2
    [-inputScript] <String>
    [[-cursorColumn] <Int32>]
    [[-options] <Hashtable>]
    [<CommonParameters>]

TabExpansion2
    [-ast] <Ast>
    [-tokens] <Token[]>
    [-positionOfCursor] <IScriptPosition>
    [[-options] <Hashtable>]
    [<CommonParameters>]

TabExpansion2 是一个内置函数，提供用户输入的选项卡完成。 当用户在键入命令时按 Tab 或 Ctrl+Space 键时，PowerShell 将调用此函数。 该函数返回当前输入可能完成的列表。

用户通常不会直接调用 TabExpansion2。 但是，它可用于测试选项卡完成。 若要使用 TabExpansion2，需要提供脚本中的当前输入脚本和游标位置。 该函数返回一个 CommandCompletion 对象，该对象包含当前输入可能的完成列表。 此输入脚本可以是表示脚本的字符串或抽象语法树（AST）。

可以通过在 PowerShell 会话中定义具有相同名称的自定义函数来替代 TabExpansion2 的默认行为。 此自定义函数可以为自定义命令或参数提供完成。 虽然可以替代 TabExpansion2，但不支持。 仅当需要自定义选项卡完成行为时，才应创建自定义函数。

此示例显示了在 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

此示例演示如何获取参数值的选项卡完成。 在此示例中，我们预计 Stage 参数有三个可能的值，其中一个值 Three。 可以使用此方法测试函数的选项卡完成结果是否返回预期结果。

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

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

True
True

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。