CompletionProviderBase Class
Implements an abstract base class for a completion provider.
public abstract class CompletionProviderBase : ICompletionProvider, IOrderable, IKeyedObject- Inheritance:
- object object
- Derived:
- DotNetCompletionProviderBase JavaScriptCompletionProvider PythonCompletionProvider XmlCompletionProvider
- Implements:
- ICompletionProvider IOrderable IKeyedObject
Remarks
Instances of this object can be registered with an ISyntaxLanguage using the RegisterService(object, object) method. Once an instance is registered with the language as a service, its features can be used by the language.
Constructors
CompletionProviderBase()
Initializes a new instance of the CompletionProviderBase class.
protected CompletionProviderBase()CompletionProviderBase(string)
Initializes a new instance of the CompletionProviderBase class.
protected CompletionProviderBase(string key)| Parameter | Type | Description |
|---|---|---|
| key | string | The string-based key that identifies the provider. |
CompletionProviderBase(string, params Ordering[])
Initializes a new instance of the CompletionProviderBase class.
protected CompletionProviderBase(string key, params Ordering[] orderings)| Parameter | Type | Description |
|---|---|---|
| key | string | The string-based key that identifies the provider. |
| orderings | Ordering[] | The array of Ordering objects, used to determine how this object is positioned relative to other objects. |
Properties
Key
Gets the string-based key that identifies the provider.
public string Key { get; }Property Value
- string:
The string-based key that identifies the provider.
Orderings
Gets the collection of Ordering objects, used to determine how this object is positioned relative to other objects.
public IEnumerable<Ordering> Orderings { get; }Property Value
- IEnumerable<Ordering>:
The collection of Ordering objects, used to determine how this object is positioned relative to other objects.
Methods
RequestSession(IEditorView, bool)
Requests that an ICompletionSession be opened for the specified IEditorView.
public abstract bool RequestSession(IEditorView view, bool canCommitWithoutPopup)| Parameter | Type | Description |
|---|---|---|
| view | IEditorView | The IEditorView that will host the session. |
| canCommitWithoutPopup | bool | Whether the session can immediately commit if a single match is made when the session is opened, commonly known as "complete word" functionality. |
Returns
- bool:
trueif a session was opened; otherwise,false.