Edit

Share via

CollectionConverter.GetProperties Method

  • Reference

Definition

Namespace:
System.ComponentModel
Assembly:
System.ComponentModel.TypeConverter.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Source:
CollectionConverter.cs
Source:
CollectionConverter.cs
Source:
CollectionConverter.cs

Gets a collection of properties for the type of array specified by the value parameter using the specified context and attributes.

public:
 override System::ComponentModel::PropertyDescriptorCollection ^ GetProperties(System::ComponentModel::ITypeDescriptorContext ^ context, System::Object ^ value, cli::array <Attribute ^> ^ attributes);
public override System.ComponentModel.PropertyDescriptorCollection GetProperties (System.ComponentModel.ITypeDescriptorContext context, object value, Attribute[] attributes);
public override System.ComponentModel.PropertyDescriptorCollection GetProperties (System.ComponentModel.ITypeDescriptorContext? context, object value, Attribute[]? attributes);
override this.GetProperties : System.ComponentModel.ITypeDescriptorContext * obj * Attribute[] -> System.ComponentModel.PropertyDescriptorCollection
Public Overrides Function GetProperties (context As ITypeDescriptorContext, value As Object, attributes As Attribute()) As PropertyDescriptorCollection

Parameters

context
ITypeDescriptorContext

An ITypeDescriptorContext that provides a format context.

value
Object

An Object that specifies the type of array to get the properties for.

attributes
Attribute[]

An array of type Attribute that will be used as a filter.

Returns

PropertyDescriptorCollection

A PropertyDescriptorCollection with the properties that are exposed for this data type, or null if there are no properties. This method always returns null.

Remarks

The context parameter can be used to extract additional information about the environment this converter is being invoked from. This can be null, so always check. Also, properties on the context object can return null.

The attributes array that you pass in will be used to filter the array. The attributes can have a mix of Type and Attribute objects. Filtering is defined by the following rules:

  • A Type object will be treated as a wildcard; it will match any property that has the Type in its set of attributes.

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

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

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

Collections do not support properties; therefore, this method always returns null.

Applies to

See also