TypeConverter.GetProperties Method

Definition

Returns a collection of properties for the type of array specified by the value parameter.

Overloads

GetProperties(Object)

Returns a collection of properties for the type of array specified by the value parameter.

GetProperties(ITypeDescriptorContext, Object)

Returns a collection of properties for the type of array specified by the value parameter, using the specified context.

GetProperties(ITypeDescriptorContext, Object, Attribute[])

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

GetProperties(Object)

Source:
TypeConverter.cs
Source:
TypeConverter.cs
Source:
TypeConverter.cs

Returns a collection of properties for the type of array specified by the value parameter.

C#
public System.ComponentModel.PropertyDescriptorCollection GetProperties(object value);
C#
public System.ComponentModel.PropertyDescriptorCollection? GetProperties(object value);

Parameters

value
Object

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

Returns

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

Remarks

As implemented in this class, this method always returns null.

By default, a type does not return properties. An easy implementation of this method can call GetProperties for the correct data type.

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7 (package-provided), 4.7, 4.7.1 (package-provided), 4.7.1, 4.7.2 (package-provided), 4.7.2, 4.8 (package-provided), 4.8, 4.8.1
.NET Standard 2.0, 2.1

GetProperties(ITypeDescriptorContext, Object)

Source:
TypeConverter.cs
Source:
TypeConverter.cs
Source:
TypeConverter.cs

Returns a collection of properties for the type of array specified by the value parameter, using the specified context.

C#
public System.ComponentModel.PropertyDescriptorCollection GetProperties(System.ComponentModel.ITypeDescriptorContext context, object value);
C#
public System.ComponentModel.PropertyDescriptorCollection? GetProperties(System.ComponentModel.ITypeDescriptorContext? context, object value);

Parameters

context
ITypeDescriptorContext

An ITypeDescriptorContext that provides a format context.

value
Object

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

Returns

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

Remarks

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

As implemented in this class, this method always returns null.

By default, a type does not return properties. An easy implementation of this method can call GetProperties for the correct data type.

See also

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7 (package-provided), 4.7, 4.7.1 (package-provided), 4.7.1, 4.7.2 (package-provided), 4.7.2, 4.8 (package-provided), 4.8, 4.8.1
.NET Standard 2.0, 2.1

GetProperties(ITypeDescriptorContext, Object, Attribute[])

Source:
TypeConverter.cs
Source:
TypeConverter.cs
Source:
TypeConverter.cs

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

C#
public virtual System.ComponentModel.PropertyDescriptorCollection GetProperties(System.ComponentModel.ITypeDescriptorContext context, object value, Attribute[] attributes);
C#
public virtual System.ComponentModel.PropertyDescriptorCollection? GetProperties(System.ComponentModel.ITypeDescriptorContext? context, object value, Attribute[]? attributes);

Parameters

context
ITypeDescriptorContext

An ITypeDescriptorContext that provides a format context.

value
Object

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

attributes
Attribute[]

An array of type Attribute that is used as a filter.

Returns

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

Remarks

As implemented in this class, this method always returns null.

Notes to Inheritors

Override this method if the type you want to convert supports properties.

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

The attributes array is 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 is treated as a wildcard; it matches a property that has the Type in its set of attributes.

  • 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 Attribute, 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.

See also

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7 (package-provided), 4.7, 4.7.1 (package-provided), 4.7.1, 4.7.2 (package-provided), 4.7.2, 4.8 (package-provided), 4.8, 4.8.1
.NET Standard 2.0, 2.1