ICompletionItemMatcher Interface
Provides the base requirements for an object that can match completion items based on supplied text.
public interface ICompletionItemMatcher : IKeyedObjectMethods
GetHighlightedTextRanges(ICompletionSession, ICompletionItem, string)
Returns a collection of TextRange objects that specify the ranges of matched characters within an ICompletionItem's Text.
IEnumerable<TextRange> GetHighlightedTextRanges(ICompletionSession session, ICompletionItem item, string text)| Parameter | Type | Description |
|---|---|---|
| session | ICompletionSession | The ICompletionSession in which the match is to be made. |
| item | ICompletionItem | The ICompletionItem against which to match. |
| text | string | The text to use for matching. |
Returns
- IEnumerable<TextRange>:
A collection of TextRange objects that specify the ranges of matched characters within an ICompletionItem's Text.
Match(ICompletionSession, IEnumerable, string, bool)
Attempts to locate an ICompletionItem match based on specified text.
CompletionSelection Match(ICompletionSession session, IEnumerable items, string text, bool uniqueFullMatchOnly)| Parameter | Type | Description |
|---|---|---|
| session | ICompletionSession | The ICompletionSession in which the match is to be made. |
| items | IEnumerable | The collection of items against which to match. |
| text | string | The text to use for matching. |
| uniqueFullMatchOnly | bool | Whether to only return a match if it is a full and unique match. |
Returns
- CompletionSelection:
A CompletionSelection instance, if a match was made.