TabExpansion2

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

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

TabExpansion2 é uma função interna que fornece preenchimento de guias para entrada do usuário. O PowerShell chama essa função quando o usuário pressiona a Tab ou tecla Ctrl+Space enquanto digita um comando. A função retorna uma lista de possíveis conclusões para a entrada atual.

TabExpansion2 normalmente não é chamado diretamente pelos usuários. No entanto, pode ser útil para testar o preenchimento de guias. Para usáTabExpansion2, você precisa fornecer o script de entrada atual e a posição do cursor no script. A função retorna um objeto CommandCompletion que contém uma lista de possíveis conclusões para a entrada atual. Esse script de entrada pode ser uma cadeia de caracteres ou uma árvore de sintaxe abstrata (AST) que representa o script.

Você pode substituir o comportamento padrão do TabExpansion2 definindo uma função personalizada com o mesmo nome em sua sessão do PowerShell. Esta função personalizada pode fornecer completações para comandos ou parâmetros personalizados. Embora seja possível substituir TabExpansion2, ela não é suportada. Você deve criar uma função personalizada somente se tiver uma necessidade específica de personalizar o comportamento de conclusão da guia.

Este exemplo mostra os mesmos resultados que você obteria inserindo Format-Hex -<Tab> no prompt de comando do PowerShell. A função TabExpansion2 retorna um objeto CommandCompletion que contém uma lista de possíveis conclusões para o token -.

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

Este exemplo mostra como obter o preenchimento de guias para valores de parâmetro. Neste exemplo, esperamos que parâmetro Stage tenha três valores possíveis e que um dos valores seja Three. Você pode usar essa técnica para testar que a conclusão da guia para sua função retorna os resultados esperados.

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

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.