This documentation is archived and is not being maintained.

ITypeDescriptorFilterService.FilterAttributes Method

Filters the attributes that a component exposes through a TypeDescriptor.

[Visual Basic]
Function FilterAttributes( _
   ByVal component As IComponent, _
   ByVal attributes As IDictionary _
) As Boolean
[C#]
bool FilterAttributes(
   IComponent component,
 IDictionary attributes
);
[C++]
bool FilterAttributes(
   IComponent* component,
 IDictionary* attributes
);
[JScript]
function FilterAttributes(
   component : IComponent,
 attributes : IDictionary
) : Boolean;

Parameters

component
The component to filter the attributes of.
attributes
A dictionary of attributes that can be modified.

Return Value

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

Remarks

This method is called when a user requests a set of attributes for a component. The attributes are added to the dictionary with the attribute type ID as the keys. Implementers of this service can make changes, add, or remove attributes in the dictionary.

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

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

ITypeDescriptorFilterService Interface | ITypeDescriptorFilterService Members | System.ComponentModel.Design Namespace

Show: