ITypeDescriptorFilterService.FilterEvents(IComponent, IDictionary) Method

Reference

Definition

Namespace:: System.ComponentModel.Design

Assembly:: System.ComponentModel.TypeConverter.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Filters the events that a component exposes through a TypeDescriptor.

public:
 bool FilterEvents(System::ComponentModel::IComponent ^ component, System::Collections::IDictionary ^ events);

public bool FilterEvents (System.ComponentModel.IComponent component, System.Collections.IDictionary events);

abstract member FilterEvents : System.ComponentModel.IComponent * System.Collections.IDictionary -> bool

Public Function FilterEvents (component As IComponent, events As IDictionary) As Boolean

Parameters

component: IComponent

The component to filter events for.

events: IDictionary

A dictionary of events that can be modified.

Returns

Boolean

true if the set of filtered events is to be cached; false if the filter service must query again.

Remarks

This method is called when a user requests a set of events for a component. The events are added to the dictionary with the event names as the keys and the corresponding EventDescriptor objects as the values. Implementers of this service can add, remove, or alter event entries in the dictionary.

Notes to Implementers

Return false only when necessary, because repeated queries to the type descriptor filter service can decrease performance.

Applies to