CompletionFilterWithState Class

Definition

Namespace:

Microsoft.VisualStudio.Language.Intellisense.AsyncCompletion.Data

Assembly:

Microsoft.VisualStudio.Language.dll

Package:

Microsoft.VisualStudio.Language v17.12.215

Immutable data transfer object that describes state of a CompletionFilter: whether it IsAvailable based on typed text and whether it IsSelected by the user.

public ref class CompletionFilterWithState sealed

public sealed class CompletionFilterWithState

type CompletionFilterWithState = class

Public NotInheritable Class CompletionFilterWithState

Inheritance

Object

CompletionFilterWithState

Constructors

CompletionFilterWithState(CompletionFilter, Boolean, Boolean)	Constructs a new instance of CompletionFilterWithState when selected state is known.
CompletionFilterWithState(CompletionFilter, Boolean)	Constructs a new instance of CompletionFilterWithState which is not selected.

Properties

Filter	Reference to the completion filter
IsAvailable	Whether the filter is available. A filter is available if after filtering by entered text, there are any CompletionItems that reference this Filter in their Filters Filtering CompletionItems by toggling IsSelected property of the CompletionFilters has no impact on this availability.
IsSelected	Whether the filter is selected by the user. User may select a filter using mouse or a keyboard shortcut.

Methods

ToString()	Override for debugger display
WithAvailability(Boolean)	Returns instance of CompletionFilterWithState with specified IsAvailable. Use this method when entered text changes availability of relevant CompletionItems.
WithSelected(Boolean)	Returns instance of CompletionFilterWithState with specified IsSelected