AttributeCollection Class
Represents a collection of attributes.
Assembly: System (in System.dll)
The AttributeCollection type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | AttributeCollection() | Initializes a new instance of the AttributeCollection class. |
![]() ![]() | AttributeCollection(array<Attribute>) | Initializes a new instance of the AttributeCollection class. |
| Name | Description | |
|---|---|---|
![]() | Attributes | Gets the attribute collection. |
![]() ![]() | Count | Gets the number of attributes. |
![]() ![]() | Item[Int32] | Gets the attribute with the specified index number. |
![]() ![]() | Item[Type] | Gets the attribute with the specified type. |
| Name | Description | |
|---|---|---|
![]() ![]() | Contains(Attribute) | Determines whether this collection of attributes has the specified attribute. |
![]() | Contains(array<Attribute>) | Determines whether this attribute collection contains all the specified attributes in the attribute array. |
![]() ![]() | CopyTo | Copies the collection to an array, starting at the specified index. |
![]() ![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() ![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() | FromExisting | Creates a new AttributeCollection from an existing AttributeCollection. |
![]() ![]() | GetDefaultAttribute | Returns the default Attribute of a given Type. |
![]() ![]() | GetEnumerator | Gets an enumerator for this collection. |
![]() ![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() ![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() ![]() | Matches(Attribute) | Determines whether a specified attribute is the same as an attribute in the collection. |
![]() | Matches(array<Attribute>) | Determines whether the attributes in the specified array are the same as the attributes in the collection. |
![]() ![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() ![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() | AsParallel | Enables parallelization of a query. (Defined by ParallelEnumerable.) |
![]() | AsQueryable | Converts an IEnumerable to an IQueryable. (Defined by Queryable.) |
![]() ![]() | Cast<TResult> | Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.) |
![]() ![]() | OfType<TResult> | Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.) |
| Name | Description | |
|---|---|---|
![]() ![]() ![]() | ICollection::Count | Gets the number of elements contained in the collection. |
![]() ![]() ![]() | ICollection::IsSynchronized | Gets a value indicating whether access to the collection is synchronized (thread-safe). |
![]() ![]() ![]() | ICollection::SyncRoot | Gets an object that can be used to synchronize access to the collection. |
![]() ![]() ![]() | IEnumerable::GetEnumerator | Returns an IEnumerator for the IDictionary. |
The AttributeCollection class is read-only; it does not implement methods to add or remove attributes. You must inherit from this class to implement these methods.
Use the Count property to find the number of attributes that exist in the collection.
You can also use the methods of this class to query the collection about its contents. Call the Contains method to verify that a specified attribute or attribute array exists in the collection. Call the Matches method to verify that a specified attribute or array of attributes exists in the collection, and that the values of the specified attributes are the same as the values in the collection.
While most attributes have default values, default values are not required. If an attribute has no default value, nullptr is returned from the indexed property that takes a type. When defining your own attributes, you can declare a default value by either providing a constructor that takes no arguments, or defining a public static field of your attribute type named "Default".
Note |
|---|
The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Synchronization. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes. |
The first code example checks to see whether the BrowsableAttribute has been set in this collection. The second code example gets the actual value of the DescriptionAttribute for a button. Both examples require that button1 and textBox1 have been created on a form. When using attributes, verify that an attribute has been set, or access its value.
private: void ContainsAttribute() { // Creates a new collection and assigns it the attributes for button1. AttributeCollection^ attributes; attributes = TypeDescriptor::GetAttributes( button1 ); // Sets an Attribute to the specific attribute. BrowsableAttribute^ myAttribute = BrowsableAttribute::Yes; if ( attributes->Contains( myAttribute ) ) { textBox1->Text = "button1 has a browsable attribute."; } else { textBox1->Text = "button1 does not have a browsable attribute."; } }
private: void GetAttributeValue() { // Creates a new collection and assigns it the attributes for button1. AttributeCollection^ attributes; attributes = TypeDescriptor::GetAttributes( button1 ); // Gets the designer attribute from the collection. DesignerAttribute^ myDesigner; myDesigner = (DesignerAttribute^)(attributes[DesignerAttribute::typeid]); // Prints the value of the attribute in a text box. textBox1->Text = myDesigner->DesignerTypeName; }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

