ICompletionFilter Interface (ActiproSoftware.Windows.Controls.SyntaxEditor.IntelliPrompt)

Provides the base requirements for an object that can filter out items from an IntelliPrompt completion list.

public interface ICompletionFilter : IKeyedObject

Properties

Gets or sets the name of the group that contains this filter.

string GroupName { get; set; }

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.

Gets or sets whether the filter is currently active.

bool IsActive { get; set; }

When the filter is not active, it will not have its Filter(ICompletionSession, ICompletionItem) method to examine items.

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.

CompletionFilterResult:: A CompletionFilterResult value that indicates if the item meets filter conditions.