DotNetCompletionProviderBase Class
Provides an abstract base class for providing IntelliPrompt completion data for .NET languages.
public abstract class DotNetCompletionProviderBase : CompletionProviderBase, ICompletionProvider, IOrderable, IKeyedObject
- Inheritance:
- object CompletionProviderBase object
- Implements:
- ICompletionProvider IOrderable IKeyedObject
Constructors
DotNetCompletionProviderBase(string)
Initializes a new instance of the DotNetCompletionProviderBase
class.
protected DotNetCompletionProviderBase(string key)
Parameter | Type | Description |
---|---|---|
key | string | The string-based key that identifies the provider. |
Properties
CanShowOnTypedWordStart
Gets or sets whether a completion list can auto-show when typing a new word.
public bool CanShowOnTypedWordStart { get; set; }
Property Value
- bool:
true
if a completion list can auto-show when typing a new word; otherwise,false
.
Methods
CreateContext(IEditorView)
Creates an IDotNetContext for the caret's offset in the specified IEditorView.
protected abstract IDotNetContext CreateContext(IEditorView view)
Parameter | Type | Description |
---|---|---|
view | IEditorView | The IEditorView to examine. |
Returns
- IDotNetContext:
An IDotNetContext for the caret's offset in the specified IEditorView.
OnSessionOpening(ICompletionSession)
Allows an inheritor to modify, filter and sort automatically-generated items before the specified ICompletionSession is opened and displayed to the end user. The session may also be cancelled.
protected virtual bool OnSessionOpening(ICompletionSession session)
Parameter | Type | Description |
---|---|---|
session | ICompletionSession | The ICompletionSession about to be opened. |
Returns
- bool:
true
if the session is allowed to open; otherwise,false
.
Remarks
The default implementation of this method sorts the items in the session.
ShouldShowForTypedWordStart(IEditorView)
Returns whether the specified IEditorView supports automatic completion list display at its current caret location.
public abstract bool ShouldShowForTypedWordStart(IEditorView view)
Parameter | Type | Description |
---|---|---|
view | IEditorView | The IEditorView to examine. |
Returns
- bool:
true
if automatic completion list display is supported; otherwise,false
.