PropertyDescriptorCollection Class

 

Represents a collection of PropertyDescriptor objects.

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

System.Object
  System.ComponentModel.PropertyDescriptorCollection

[HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true)]
public class PropertyDescriptorCollection : ICollection, IEnumerable, 
	IList, IDictionary

NameDescription
System_CAPS_pubmethodPropertyDescriptorCollection(PropertyDescriptor[])

Initializes a new instance of the PropertyDescriptorCollection class.

System_CAPS_pubmethodPropertyDescriptorCollection(PropertyDescriptor[], Boolean)

Initializes a new instance of the PropertyDescriptorCollection class, which is optionally read-only.

NameDescription
System_CAPS_pubpropertyCount

Gets the number of property descriptors in the collection.

System_CAPS_pubpropertyItem[Int32]

Gets or sets the PropertyDescriptor at the specified index number.

System_CAPS_pubpropertyItem[String]

Gets or sets the PropertyDescriptor with the specified name.

NameDescription
System_CAPS_pubmethodAdd(PropertyDescriptor)

Adds the specified PropertyDescriptor to the collection.

System_CAPS_pubmethodClear()

Removes all PropertyDescriptor objects from the collection.

System_CAPS_pubmethodContains(PropertyDescriptor)

Returns whether the collection contains the given PropertyDescriptor.

System_CAPS_pubmethodCopyTo(Array, Int32)

Copies the entire collection to an array, starting at the specified index number.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFind(String, Boolean)

Returns the PropertyDescriptor with the specified name, using a Boolean to indicate whether to ignore case.

System_CAPS_pubmethodGetEnumerator()

Returns an enumerator for this class.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIndexOf(PropertyDescriptor)

Returns the index of the given PropertyDescriptor.

System_CAPS_pubmethodInsert(Int32, PropertyDescriptor)

Adds the PropertyDescriptor to the collection at the specified index number.

System_CAPS_protmethodInternalSort(IComparer)

Sorts the members of this collection, using the specified IComparer.

System_CAPS_protmethodInternalSort(String[])

Sorts the members of this collection. The specified order is applied first, followed by the default sort for this collection, which is usually alphabetical.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRemove(PropertyDescriptor)

Removes the specified PropertyDescriptor from the collection.

System_CAPS_pubmethodRemoveAt(Int32)

Removes the PropertyDescriptor at the specified index from the collection.

System_CAPS_pubmethodSort()

Sorts the members of this collection, using the default sort for this collection, which is usually alphabetical.

System_CAPS_pubmethodSort(IComparer)

Sorts the members of this collection, using the specified IComparer.

System_CAPS_pubmethodSort(String[])

Sorts the members of this collection. The specified order is applied first, followed by the default sort for this collection, which is usually alphabetical.

System_CAPS_pubmethodSort(String[], IComparer)

Sorts the members of this collection. The specified order is applied first, followed by the sort using the specified IComparer.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticEmpty

Specifies an empty collection that you can use instead of creating a new one with no items. This static field is read-only.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDictionary.Add(Object, Object)

Adds an element with the provided key and value to the IDictionary.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDictionary.Clear()

Removes all elements from the IDictionary.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDictionary.Contains(Object)

Determines whether the IDictionary contains an element with the specified key.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDictionary.GetEnumerator()

Returns an enumerator for this class.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDictionary.Remove(Object)

Removes the element with the specified key from the IDictionary.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable.GetEnumerator()

Returns an IEnumerator for the IDictionary.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Add(Object)

Adds an item to the IList.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Clear()

Removes all items from the collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Contains(Object)

Determines whether the collection contains a specific value.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.IndexOf(Object)

Determines the index of a specified item in the collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Insert(Int32, Object)

Inserts an item into the collection at a specified index.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Remove(Object)

Removes the first occurrence of a specified value from the collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.RemoveAt(Int32)

Removes the item at the specified index.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.Count

Gets the number of elements contained in the collection.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.IsSynchronized

Gets a value indicating whether access to the collection is synchronized (thread safe).

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.SyncRoot

Gets an object that can be used to synchronize access to the collection.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDictionary.IsFixedSize

Gets a value indicating whether the IDictionary has a fixed size.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDictionary.IsReadOnly

Gets a value indicating whether the IDictionary is read-only.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDictionary.Item[Object]

Gets or sets the element with the specified key.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDictionary.Keys

Gets an ICollection containing the keys of the IDictionary.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDictionary.Values

Gets an ICollection containing the values in the IDictionary.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsFixedSize

Gets a value indicating whether the collection has a fixed size.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsReadOnly

Gets a value indicating whether the collection is read-only.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.Item[Int32]

Gets or sets an item from the collection at a specified index.

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

PropertyDescriptorCollection is read-only; it does not implement methods that add or remove properties. You must inherit from this class to implement these methods.

Using the properties available in the PropertyDescriptorCollection class, you can query the collection about its contents. Use the Count property to determine the number of elements in the collection. Use the Item property to get a specific property by index number or by name.

In addition to properties, you can use the Find method to get a description of the property with the specified name from the collection.

The following code example creates a new PropertyDescriptorCollection using the properties on button1. It requires that button1 has been instantiated on a form.

PropertyDescriptorCollection properties = TypeDescriptor.GetProperties(button1);

The next example prints all the properties on a button in a text box. It requires that button1 and textBox1 have been instantiated on a form.

private void MyPropertyCollection() {
    // Creates a new collection and assign it the properties for button1.
    PropertyDescriptorCollection properties = TypeDescriptor.GetProperties(button1);

    // Displays each property in the collection in a text box.
    foreach (PropertyDescriptor myProperty in properties)
       textBox1.Text += myProperty.Name + '\n';
 }

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: