ArgumentExtensions.AddCompletions Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| AddCompletions<TArgument>(TArgument, CompletionDelegate) |
Adds completions for an argument. |
| AddCompletions<TArgument>(TArgument, Func<CompletionContext,IEnumerable<String>>) |
Adds completions for an option. |
| AddCompletions<TArgument>(TArgument, String[]) |
Adds completions for an argument. |
- Source:
- ArgumentExtensions.cs
Adds completions for an argument.
public:
generic <typename TArgument>
where TArgument : System::CommandLine::Argument[System::Runtime::CompilerServices::Extension]
static TArgument AddCompletions(TArgument argument, System::CommandLine::Completions::CompletionDelegate ^ complete);C#
public static TArgument AddCompletions<TArgument>(this TArgument argument, System.CommandLine.Completions.CompletionDelegate complete) where TArgument : System.CommandLine.Argument;static member AddCompletions : 'Argument * System.CommandLine.Completions.CompletionDelegate -> 'Argument (requires 'Argument :> System.CommandLine.Argument)<Extension()>
Public Function AddCompletions(Of TArgument As Argument) (argument As TArgument, complete As CompletionDelegate) As TArgumentType Parameters
- TArgument
The type of the argument.
Parameters
- argument
- TArgument
The argument for which to add completions.
- complete
- CompletionDelegate
A CompletionDelegate that will be called to provide completions.
Returns
TArgument
The configured argument.
Applies to
.NET 10 (package-provided) and other versions
| Product | Versions |
|---|---|
| .NET | 6 (package-provided), 7 (package-provided), 8 (package-provided), 9 (package-provided), 10 (package-provided) |
| .NET Standard | 2.0 (package-provided) |
- Source:
- ArgumentExtensions.cs
Adds completions for an option.
public:
generic <typename TArgument>
where TArgument : System::CommandLine::Argument[System::Runtime::CompilerServices::Extension]
static TArgument AddCompletions(TArgument argument, Func<System::CommandLine::Completions::CompletionContext ^, System::Collections::Generic::IEnumerable<System::String ^> ^> ^ complete);C#
public static TArgument AddCompletions<TArgument>(this TArgument argument, Func<System.CommandLine.Completions.CompletionContext,System.Collections.Generic.IEnumerable<string>> complete) where TArgument : System.CommandLine.Argument;static member AddCompletions : 'Argument * Func<System.CommandLine.Completions.CompletionContext, seq<string>> -> 'Argument (requires 'Argument :> System.CommandLine.Argument)<Extension()>
Public Function AddCompletions(Of TArgument As Argument) (argument As TArgument, complete As Func(Of CompletionContext, IEnumerable(Of String))) As TArgumentType Parameters
- TArgument
The type of the argument.
Parameters
- argument
- TArgument
The argument for which to add completions.
- complete
- Func<CompletionContext,IEnumerable<String>>
A CompletionDelegate that will be called to provide completions.
Returns
TArgument
The option being extended.
Applies to
.NET 10 (package-provided) and other versions
| Product | Versions |
|---|---|
| .NET | 6 (package-provided), 7 (package-provided), 8 (package-provided), 9 (package-provided), 10 (package-provided) |
| .NET Standard | 2.0 (package-provided) |
- Source:
- ArgumentExtensions.cs
Adds completions for an argument.
public:
generic <typename TArgument>
where TArgument : System::CommandLine::Argument[System::Runtime::CompilerServices::Extension]
static TArgument AddCompletions(TArgument argument, ... cli::array <System::String ^> ^ values);C#
public static TArgument AddCompletions<TArgument>(this TArgument argument, params string[] values) where TArgument : System.CommandLine.Argument;static member AddCompletions : 'Argument * string[] -> 'Argument (requires 'Argument :> System.CommandLine.Argument)<Extension()>
Public Function AddCompletions(Of TArgument As Argument) (argument As TArgument, ParamArray values As String()) As TArgumentType Parameters
- TArgument
The type of the argument.
Parameters
- argument
- TArgument
The argument for which to add completions.
- values
- String[]
The completions to add.
Returns
TArgument
The configured argument.
Applies to
.NET 10 (package-provided) and other versions
| Product | Versions |
|---|---|
| .NET | 6 (package-provided), 7 (package-provided), 8 (package-provided), 9 (package-provided), 10 (package-provided) |
| .NET Standard | 2.0 (package-provided) |
