CompletionItem(String, String, String, String, String, String) Constructor

Definition

Namespace:

System.CommandLine.Completions

Assembly:

System.CommandLine.dll

Package:

System.CommandLine v2.0.0-beta4.22272.1

Source:

CompletionItem.cs

public CompletionItem(string label, string kind = "Value", string? sortText = default, string? insertText = default, string? documentation = default, string? detail = default);

new System.CommandLine.Completions.CompletionItem : string * string * string * string * string * string -> System.CommandLine.Completions.CompletionItem

Public Sub New (label As String, Optional kind As String = "Value", Optional sortText As String = Nothing, Optional insertText As String = Nothing, Optional documentation As String = Nothing, Optional detail As String = Nothing)

Parameters

label

String

The label value, which is the text displayed to users and, unless insertText is set, is also used to populate the InsertText property.

kind

String

The kind of completion item.

sortText

String

The value used to sort the completion item in a list. If this is not provided, then label is used.

insertText

String

The text to be inserted by this completion item. If this is not provided, then label is used.

documentation

String

Documentation about the completion item.

detail

String

Additional details regarding the completion item.