This documentation is archived and is not being maintained.

ITypeDescriptorFilterService.FilterProperties Method

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
)

Parameters

component
Type: System.ComponentModel.IComponent

The component to filter properties for.

properties
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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: