CompletionItem
Object Hierarchy:
Description:
[ Compact ( opaque = true ) ]
[ CCode ( ref_function = "lsp_completion_item_ref" , unref_function = "lsp_completion_item_unref" ) ]
public class CompletionItem
A completion item is an option in a list of completions generated when calling `textDocument/completion`.
Content:
Properties:
- public TextEdit[]? additional_text_edits { get; set; }
- public Command? command { get; set; }
An optional command that is executed *after* inserting this
completion. *Note* that additional modifications to the current document should be described with the additionalTextEdits-property.
- public string[]? commit_chars { get; set; }
- public Variant? data { get; set; }
A data entry field that is preserved on a completion item between a
completion and a completion resolve request.
- public bool deprecated { get; set; }
Whether this completion item is deprecated.
- public string? detail { get; set; }
A human-readable string with additional information about this item,
like type or symbol information.
- public MarkupContent? documentation { get; set; }
A human-readable string that represents a doc-comment.
- public string? filter_text { get; set; }
A string that should be used when filtering a set of completion items.
When omitted, the label is used as the filter text for this item.
- public string? insert_text { get; set; }
A string that should be inserted into a document when selecting this
completion. When `falsy` the label is used as the insert text for this item.
- public InsertTextFormat insert_text_format { get; set; }
The format of the insert text. The format applies to both the
`insertText` property and the `newText` property of a provided `textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.
- public InsertTextMode insert_text_mode { get; set; }
How whitespace and indentation is handled during completion item
insertion. If not provided the client's default value depends on the `textDocument.completion.insertTextMode` client capability.
- public CompletionItemKind kind { get; set; }
The kind of this completion item.
- public string label { get; set; }
The label of this completion item.
- public CompletionItemLabelDetails? label_details { get; set; }
Additional details for the label.
- public bool preselect { get; set; }
Select this item when showing.
- public string? sort_text { get; set; }
A string that should be used when comparing this item with other
items. When omitted, the label is used as the sort text for this item.
- public CompletionItemTag tags { get; set; }
Tags for this completion item.
- public TextEdit? text_edit { get; owned set; }
An edit which is applied to a document when selecting this completion.
When an edit is provided the value of `insertText` is ignored.
Creation methods:
Methods: