ITypeDescriptorFilterService.FilterProperties(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 properties that a component exposes through a TypeDescriptor.

public:
 bool FilterProperties(System::ComponentModel::IComponent ^ component, System::Collections::IDictionary ^ properties);

public bool FilterProperties (System.ComponentModel.IComponent component, System.Collections.IDictionary properties);

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

Public Function FilterProperties (component As IComponent, properties As IDictionary) As Boolean

Parameters

component: IComponent

The component to filter properties for.

properties: IDictionary

A dictionary of properties that can be modified.

Returns

Boolean

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

Remarks

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.

Applies to