Edit

Share via


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

Definition

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.

Applies to