Edit

Share via


CompletionContext.GetWordToComplete Method

Definition

Overloads

GetWordToComplete(ParseResult, Nullable<Int32>)
GetWordToComplete(ParseResult, Nullable<Int32>)

Gets the text to be matched for completion, which can be used to filter a list of completions.

GetWordToComplete(ParseResult, Nullable<Int32>)

Source:
CompletionContext.cs
protected static string GetWordToComplete(System.CommandLine.ParseResult parseResult, int? position = default);
static member GetWordToComplete : System.CommandLine.ParseResult * Nullable<int> -> string
Protected Shared Function GetWordToComplete (parseResult As ParseResult, Optional position As Nullable(Of Integer) = Nothing) As String

Parameters

parseResult
ParseResult
position
Nullable<Int32>

Returns

Applies to

GetWordToComplete(ParseResult, Nullable<Int32>)

Source:
CompletionContext.cs

Gets the text to be matched for completion, which can be used to filter a list of completions.

protected static string GetWordToComplete(System.CommandLine.Parsing.ParseResult parseResult, int? position = default);
static member GetWordToComplete : System.CommandLine.Parsing.ParseResult * Nullable<int> -> string
Protected Shared Function GetWordToComplete (parseResult As ParseResult, Optional position As Nullable(Of Integer) = Nothing) As String

Parameters

parseResult
ParseResult

A parse result.

position
Nullable<Int32>

The position within the raw input, if available, at which to provide completions.

Returns

A string containing the user-entered text to be matched for completions.

Applies to