Export (0) Print
Expand All

TypeDescriptor.GetProperties Method (Type, Attribute[])

Returns the collection of properties for a specified type of component using a specified array of attributes as a filter.

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

public static PropertyDescriptorCollection GetProperties (
	Type componentType,
	Attribute[] attributes
)
public static PropertyDescriptorCollection GetProperties (
	Type componentType, 
	Attribute[] attributes
)
public static function GetProperties (
	componentType : Type, 
	attributes : Attribute[]
) : PropertyDescriptorCollection
Not applicable.

Parameters

componentType

The Type of the target component.

attributes

An array of type Attribute to use as a filter.

Return Value

A PropertyDescriptorCollection with the properties that match the specified attributes for this type of component.

Call this version of this method only when you do not have an instance of the object.

The attributes parameter array is used to filter the array. Filtering is defined by the following rules:

  • If a property does not have an Attribute of the same class, the property is not included in the returned array.

  • If the attribute is an instance of the Attribute class, the property must be an exact match or it is not included in the returned array.

  • If an Attribute instance is specified and it is the default property, it is included in the returned array even if there is no instance of the Attribute in the property.

  • If attributes has a default attribute, the GetProperties method matches the case when the property does not have the attribute applied.

If the componentType parameter is a null reference (Nothing in Visual Basic), an empty collection is returned.

The order of the returned collection is not guaranteed to be identical between calls, so always order it before use.

The following code example demonstrates how to implement the GetProperties method. This code example is part of a larger example provided for the PropertyTab class.

// Returns the properties of the specified component extended with 
// a CategoryAttribute reflecting the name of the type of the property.
public override System.ComponentModel.PropertyDescriptorCollection GetProperties(object component, System.Attribute[] attributes)
{
    PropertyDescriptorCollection props;
    if( attributes == null )
        props = TypeDescriptor.GetProperties(component);    
    else
        props = TypeDescriptor.GetProperties(component, attributes);    
    
    PropertyDescriptor[] propArray = new PropertyDescriptor[props.Count];            
    for(int i=0; i<props.Count; i++)           
    {                
        // Create a new PropertyDescriptor from the old one, with 
        // a CategoryAttribute matching the name of the type.
        propArray[i] = TypeDescriptor.CreateProperty(props[i].ComponentType, props[i], new CategoryAttribute(props[i].PropertyType.Name));
    }
    return new PropertyDescriptorCollection( propArray );
}

public override System.ComponentModel.PropertyDescriptorCollection GetProperties(object component)
{                     
    return this.GetProperties(component, null);
}

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft