Register-ArgumentCompleter
Registrerar en komplettering av ett anpassat argument.
Syntax
Register-ArgumentCompleter
-CommandName <String[]>
-ScriptBlock <ScriptBlock>
[-Native]
[<CommonParameters>]
Register-ArgumentCompleter
[-CommandName <String[]>]
-ParameterName <String>
-ScriptBlock <ScriptBlock>
[<CommonParameters>]
Description
Cmdleten Register-ArgumentCompleter
registrerar en slutförd anpassad argument. Med en argumentföreläsning kan du ange dynamisk flikavslut, vid körning för alla kommandon som du anger.
Exempel
Exempel 1: Registrera en slutförd anpassad argument
I följande exempel registreras en argumenteparameter för ID-parametern för cmdleten Set-TimeZone
.
$scriptBlock = {
param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters)
(Get-TimeZone -ListAvailable).Id | Where-Object {
$_ -like "$wordToComplete*"
} | ForEach-Object {
"'$_'"
}
}
Register-ArgumentCompleter -CommandName Set-TimeZone -ParameterName Id -ScriptBlock $scriptBlock
Det första kommandot skapar ett skriptblock som tar de obligatoriska parametrar som skickas när användaren trycker på Tabb. Mer information finns i parameterbeskrivningen ScriptBlock .
I skriptblocket hämtas tillgängliga värden för ID med hjälp av cmdleten Get-TimeZone
. Egenskapen ID för varje tidszon skickas till cmdleten Where-Object
. Cmdleten Where-Object
filtrerar bort alla ID:er som inte börjar med värdet som anges av $wordToComplete
, som representerar texten som användaren skrev innan de tryckte på Tabb. De filtrerade ID:erna skickas till cmdleten ForEach-Object
som omger varje värde inom citattecken om värdet innehåller blanksteg.
Det andra kommandot registrerar argumentet completer genom att skicka scriptblock, ParameterName ID och CommandName Set-TimeZone
.
Exempel 2: Lägg till information i tabbavslutsvärdena
Följande exempel skriver över flikens slutförande för parametern Namn för cmdleten Stop-Service
och returnerar endast tjänster som körs.
$s = {
param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters)
$services = Get-Service | Where-Object {$_.Status -eq "Running" -and $_.Name -like "$wordToComplete*"}
$services | ForEach-Object {
New-Object -Type System.Management.Automation.CompletionResult -ArgumentList $_.Name,
$_.Name,
"ParameterValue",
$_.Name
}
}
Register-ArgumentCompleter -CommandName Stop-Service -ParameterName Name -ScriptBlock $s
Det första kommandot skapar ett skriptblock som tar de obligatoriska parametrar som skickas när användaren trycker på Tabb. Mer information finns i parameterbeskrivningen ScriptBlock .
I skriptblocket hämtar det första kommandot alla tjänster som körs med hjälp av cmdleten Where-Object
. Tjänsterna skickas till cmdleten ForEach-Object
. Cmdleten ForEach-Object
skapar ett nytt System.Management.Automation.CompletionResult-objekt och fyller det med namnet på den aktuella tjänsten (representeras av pipelinevariabeln $_.Name
).
Med objektet CompletionResult kan du ange ytterligare information för varje returnerat värde:
- completionText (Sträng) – den text som ska användas som automatiskt slutföranderesultat. Det här är värdet som skickas till kommandot.
- listItemText (Sträng) – Texten som ska visas i en lista, till exempel när användaren trycker på Ctrl-blanksteg+. Detta används endast för visning och skickas inte till kommandot när det är valt.
- resultType (CompletionResultType) – typ av slutföranderesultat.
- toolTip (Sträng) – Texten för knappbeskrivningen med information som ska visas om objektet. Detta visas när användaren väljer ett objekt efter att ha tryckt på Ctrl-blanksteg+.
Det sista kommandot visar att stoppade tjänster fortfarande kan skickas manuellt till cmdleten Stop-Service
. Flikens slutförande är den enda aspekten som påverkas.
Exempel 3: Registrera en anpassad intern argument-completer
Du kan använda den interna parametern för att tillhandahålla tab-completion för ett internt kommando. I följande exempel läggs tab-completion till för kommandoradsgränssnittet dotnet
(CLI).
Kommentar
Kommandot dotnet complete
är endast tillgängligt i version 2.0 och större av dotnet cli.
$scriptblock = {
param($wordToComplete, $commandAst, $cursorPosition)
dotnet complete --position $cursorPosition $commandAst.ToString() | ForEach-Object {
[System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
}
}
Register-ArgumentCompleter -Native -CommandName dotnet -ScriptBlock $scriptblock
Det första kommandot skapar ett skriptblock som tar de obligatoriska parametrar som skickas när användaren trycker på Tabb. Mer information finns i parameterbeskrivningen ScriptBlock .
I skriptblocket dotnet complete
används kommandot för att slutföra fliken.
Resultatet skickas till cmdleten ForEach-Object
som använder den nya statiska metoden i klassen System.Management.Automation.CompletionResult för att skapa ett nytt CompletionResult-objekt för varje värde.
Parametrar
-CommandName
Anger namnet på kommandona som en matris.
Typ: | String[] |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | False |
-Native
Anger att argumentexeparationen är för ett internt kommando där PowerShell inte kan slutföra parameternamn.
Typ: | SwitchParameter |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | False |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | False |
-ParameterName
Anger namnet på parametern vars argument håller på att slutföras. Det angivna parameternamnet får inte vara ett uppräknat värde, till exempel parametern ForegroundColor för cmdleten Write-Host
.
Mer information om uppräkningar finns i about_Enum.
Typ: | String |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | False |
-ScriptBlock
Anger vilka kommandon som ska köras för att slutföra fliken. Skriptblocket som du anger ska returnera de värden som slutför indata. Skriptblocket måste avregistrera värdena med hjälp av pipelinen (ForEach-Object
, Where-Object
osv.) eller en annan lämplig metod. Om du returnerar en matris med värden kan PowerShell behandla hela matrisen som ett flikslutvärde.
Skriptblocket måste acceptera följande parametrar i den ordning som anges nedan. Namnen på parametrarna är inte viktiga eftersom PowerShell skickar värdena efter position.
$commandName
(Position 0) – Den här parametern är inställd på namnet på kommandot som skriptblocket tillhandahåller tabbavslut för.$parameterName
(Position 1) – Den här parametern är inställd på parametern vars värde kräver att fliken slutförs.$wordToComplete
(Position 2) – Den här parametern är inställd på det värde som användaren har angett innan de trycker på Tabb. Skriptblocket bör använda det här värdet för att fastställa flikslutvärden.$commandAst
(Position 3) – Den här parametern är inställd på AST (Abstract Syntax Tree) för den aktuella indataraden. Mer information finns i Ast-klass.$fakeBoundParameters
(Position 4) – Den här parametern är inställd på en hashtable som innehåller cmdleten$PSBoundParameters
för innan användaren tryckte på Tabb. Mer information finns i about_Automatic_Variables.
När du anger den interna parametern måste skriptblocket ha följande parametrar i den angivna ordningen. Namnen på parametrarna är inte viktiga eftersom PowerShell skickar värdena efter position.
$wordToComplete
(Position 0) – Den här parametern är inställd på det värde som användaren har angett innan de trycker på Tabb. Skriptblocket bör använda det här värdet för att fastställa flikslutvärden.$commandAst
(Position 1) – Den här parametern är inställd på AST (Abstract Syntax Tree) för den aktuella indataraden. Mer information finns i Ast-klass.$cursorPosition
(Position 2) – Den här parametern är inställd på markörens position när användaren tryckte på Tabb.
Du kan också ange ett ArgumentCompleter som ett parameterattribut. Mer information finns i about_Functions_Advanced_Parameters.
Typ: | ScriptBlock |
Position: | Named |
Standardvärde: | None |
Obligatorisk: | True |
Godkänn pipeline-indata: | False |
Godkänn jokertecken: | False |
Indata
None
Du kan inte skicka objekt till den här cmdleten.
Utdata
None
Den här cmdleten returnerar inga utdata.
Feedback
https://aka.ms/ContentUserFeedback.
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i:Skicka och visa feedback för