FilterProperties Method
Collapse the table of content
Expand the table of content

ITypeDescriptorFilterService.FilterProperties Method (IComponent, IDictionary)


Filters the properties that a component exposes through a TypeDescriptor.

Namespace:   System.ComponentModel.Design
Assembly:  System (in System.dll)

bool FilterProperties(
	IComponent component,
	IDictionary properties


Type: System.ComponentModel.IComponent

The component to filter properties for.

Type: System.Collections.IDictionary

A dictionary of properties that can be modified.

Return Value

Type: System.Boolean

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

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

Notes to Implementers:

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

.NET Framework
Available since 1.1
Return to top
© 2015 Microsoft