TabExpansion2

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

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

TabExpansion2 is een ingebouwde functie die tabvoltooiing biedt voor gebruikersinvoer. PowerShell roept deze functie aan wanneer de gebruiker tijdens het typen van een opdracht op de Tab- of Ctrl+spa tietoets drukt. De functie retourneert een lijst met mogelijke voltooiingen voor de huidige invoer.

TabExpansion2 wordt normaal gesproken niet rechtstreeks door gebruikers aangeroepen. Het kan echter handig zijn om tabvoltooiing te testen. Als u TabExpansion2wilt gebruiken, moet u het huidige invoerscript en de cursorpositie in het script opgeven. De functie retourneert een CommandCompletion-object met een lijst met mogelijke voltooiingen voor de huidige invoer. Dit invoerscript kan een tekenreeks of een abstracte syntaxisstructuur (AST) zijn die het script vertegenwoordigt.

U kunt het standaardgedrag van TabExpansion2 overschrijven door een aangepaste functie met dezelfde naam in uw PowerShell-sessie te definiëren. Deze aangepaste functie kan voltooiingen bieden voor aangepaste opdrachten of parameters. Hoewel het mogelijk is om TabExpansion2te overschrijven, wordt dit niet ondersteund. U moet alleen een aangepaste functie maken als u een specifieke behoefte hebt om het voltooiingsgedrag van het tabblad aan te passen.

In dit voorbeeld ziet u dezelfde resultaten die u zou krijgen door Format-Hex -<Tab> in te voeren bij de PowerShell-opdrachtprompt. De functie TabExpansion2 retourneert een CommandCompletion--object met een lijst met mogelijke voltooiingen voor het - 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

In dit voorbeeld ziet u hoe u tabvoltooiing voor parameterwaarden kunt ophalen. In dit voorbeeld verwachten we dat parameter Fase drie mogelijke waarden heeft en dat een van de waarden Threeis. U kunt deze techniek gebruiken om te testen of de tabvoltooiing voor uw functie de verwachte resultaten retourneert.

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

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.