ICompletionFilter Interface
Provides the base requirements for an object that can filter out items from an IntelliPrompt completion list.
public interface ICompletionFilter : IKeyedObject
Properties
GroupName
Gets or sets the name of the group that contains this filter.
string GroupName { get; set; }
Property Value
- String:
The name of the group that contains this filter.
Remarks
If this filter generates a button, buttons with the same group name will be placed together and separated from other button groups by a separator.
IsActive
Gets or sets whether the filter is currently active.
bool IsActive { get; set; }
Property Value
- Boolean:
true
if the filter is currently active; otherwise,false
.
Remarks
When the filter is not active, it will not have its Filter(ICompletionSession, ICompletionItem) method to examine items.
Methods
Filter(ICompletionSession, ICompletionItem)
Examines the specified completion item to see if meets filter conditions.
CompletionFilterResult Filter(ICompletionSession session, ICompletionItem item)
Parameter | Type | Description |
---|---|---|
session | ICompletionSession | The ICompletionSession in which this filter is active. |
item | ICompletionItem | The ICompletionItem to examine. |
Returns
- CompletionFilterResult:
A CompletionFilterResult value that indicates if the item meets filter conditions.