TabExpansion2

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

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

TabExpansion2 to wbudowana funkcja, która zapewnia uzupełnianie kart dla danych wejściowych użytkownika. Program PowerShell wywołuje tę funkcję, gdy użytkownik naciska Tab lub Ctrl+spacji podczas wpisywania polecenia. Funkcja zwraca listę możliwych uzupełnień dla bieżących danych wejściowych.

TabExpansion2 nie jest zwykle wywoływana bezpośrednio przez użytkowników. Jednak może to być przydatne do ukończenia karty testowania. Aby użyć TabExpansion2, należy podać bieżący skrypt wejściowy i położenie kursora w skrycie. Funkcja zwraca obiekt CommandCompletion zawierający listę możliwych uzupełnień dla bieżących danych wejściowych. Ten skrypt wejściowy może być ciągiem lub abstrakcyjnym drzewem składni (AST), który reprezentuje skrypt.

Domyślne zachowanie TabExpansion2 można zastąpić, definiując funkcję niestandardową o tej samej nazwie w sesji programu PowerShell. Ta funkcja niestandardowa umożliwia uzupełnianie poleceń niestandardowych lub parametrów. Chociaż istnieje możliwość zastąpienia TabExpansion2, nie jest obsługiwana. Należy utworzyć funkcję niestandardową tylko wtedy, gdy masz określoną potrzebę dostosowania zachowania uzupełniania karty.

W tym przykładzie przedstawiono te same wyniki, które można uzyskać, wprowadzając Format-Hex -<Tab> w wierszu polecenia programu PowerShell. Funkcja TabExpansion2 zwraca obiekt CommandCompletion zawierający listę możliwych uzupełniania tokenu -.

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 [Object] InputObject
-Encoding            Encoding            ParameterName [string] Encoding
-Raw                 Raw                 ParameterName [switch] Raw
-Verbose             Verbose             ParameterName [switch] Verbose
-Debug               Debug               ParameterName [switch] Debug
-ErrorAction         ErrorAction         ParameterName [ActionPreference] ErrorAction
-WarningAction       WarningAction       ParameterName [ActionPreference] WarningAction
-InformationAction   InformationAction   ParameterName [ActionPreference] InformationAction
-ErrorVariable       ErrorVariable       ParameterName [string] ErrorVariable
-WarningVariable     WarningVariable     ParameterName [string] WarningVariable
-InformationVariable InformationVariable ParameterName [string] InformationVariable
-OutVariable         OutVariable         ParameterName [string] OutVariable
-OutBuffer           OutBuffer           ParameterName [int] OutBuffer
-PipelineVariable    PipelineVariable    ParameterName [string] PipelineVariable

W tym przykładzie pokazano, jak uzyskać uzupełnianie tabulacji dla wartości parametrów. W tym przykładzie oczekujemy, że parametr etapu ma trzy możliwe wartości i że jedna z wartości jest Three. Możesz użyć tej techniki, aby przetestować ukończenie tej karty dla funkcji zwraca oczekiwane wyniki.

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

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.