Click or drag to resize

CompletionList Class



The set of completions to present to the user.
Inheritance Hierarchy
SystemObject
  Microsoft.CodeAnalysis.CompletionCompletionList

Namespace:  Microsoft.CodeAnalysis.Completion
Assembly:  Microsoft.CodeAnalysis.Features (in Microsoft.CodeAnalysis.Features.dll) Version: 2.3.0-dev-56735-00. Commit Hash: <developer build>
Syntax
public sealed class CompletionList

The CompletionList type exposes the following members.

Properties
  NameDescription
Public propertyDefaultSpan Obsolete.
The span of the syntax element at the caret position when the CompletionList was created. Individual CompletionItem spans may vary.
Public propertyItems
The completion items to present to the user.
Public propertyRules
The rules used to control behavior of the completion list shown to the user during typing.
Public propertySpan
The span of the syntax element at the caret position when the CompletionList was created. The span identifies the text in the document that is used to filter the initial list presented to the user, and typically represents the region of the document that will be changed if this item is committed.
Public propertySuggestionModeItem
An optional CompletionItem that appears selected in the list presented to the user during suggestion mode. Suggestion mode disables autoselection of items in the list, giving preference to the text typed by the user unless a specific item is selected manually. Specifying a SuggestionModeItem is a request that the completion host operate in suggestion mode. The item specified determines the text displayed and the description associated with it unless a different item is manually selected. No text is ever inserted when this item is completed, leaving the text the user typed instead.
Top
Methods
  NameDescription
Public methodStatic memberCreate
Creates a new CompletionList instance.
Public methodWithDefaultSpan Obsolete.
Creates a copy of this CompletionList with the DefaultSpan property changed.
Public methodWithItems
Creates a copy of this CompletionList with the Items property changed.
Public methodWithRules
Creates a copy of this CompletionList with the Rules property changed.
Public methodWithSpan
Public methodWithSuggestionModeItem
Creates a copy of this CompletionList with the SuggestionModeItem property changed.
Top
Fields
  NameDescription
Public fieldStatic memberEmpty
The default CompletionList returned when no items are found to populate the list.
Top
See Also