Click or drag to resize

CompletionItem Class



One of many possible completions used to form the completion list presented to the user.
Inheritance Hierarchy
SystemObject
  Microsoft.CodeAnalysis.CompletionCompletionItem

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 CompletionItem : IComparable

The CompletionItem type exposes the following members.

Properties
  NameDescription
Public propertyDisplayText
The text that is displayed to the user.
Public propertyFilterText
The text used to determine if the item matches the filter and is show in the list. This is often the same as DisplayText but may be different in certain circumstances.
Public propertyProperties
Additional information attached to a completion item by it creator.
Public propertyRules
Rules that declare how this item should behave.
Public propertySortText
The text used to determine the order that the item appears in the list. This is often the same as the DisplayText but may be different in certain circumstances.
Public propertySpan
The span of the syntax element associated with this item. 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 propertyTags
Descriptive tags from CompletionTags. These tags may influence how the item is displayed.
Top
Methods
  NameDescription
Public methodAddProperty
Creates a copy of this CompletionItem with a property added to the Properties collection.
Public methodAddTag
Creates a copy of this CompletionItem with a tag added to the Tags collection.
Public methodStatic memberCreate(String, String, String, ImmutableDictionaryString, String, ImmutableArrayString, CompletionItemRules)
Public methodStatic memberCreate(String, String, String, TextSpan, ImmutableDictionaryString, String, ImmutableArrayString, CompletionItemRules) Obsolete.
Creates a new CompletionItem
Public methodToString
Public methodWithDisplayText
Creates a copy of this CompletionItem with the DisplayText property changed.
Public methodWithFilterText
Creates a copy of this CompletionItem with the FilterText property changed.
Public methodWithProperties
Creates a copy of this CompletionItem with the Properties property changed.
Public methodWithRules
Creates a copy of this CompletionItem with the Rules property changed.
Public methodWithSortText
Creates a copy of this CompletionItem with the SortText property changed.
Public methodWithSpan Obsolete.
Creates a copy of this CompletionItem with the Span property changed.
Public methodWithTags
Creates a copy of this CompletionItem with the Tags property changed.
Top
See Also