The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ConfigurationCollectionAttribute Class

.NET Framework (current version)

Other Versions

Declaratively instructs the .NET Framework to create an instance of a configuration element collection. This class cannot be inherited.

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

Inheritance Hierarchy

System::Object
System::Attribute
System.Configuration::ConfigurationCollectionAttribute

Syntax

C++

[AttributeUsageAttribute(AttributeTargets::Class | AttributeTargets::Property)]
public ref class ConfigurationCollectionAttribute sealed : Attribute

Constructors

	Name	Description
	ConfigurationCollectionAttribute(Type^)	Initializes a new instance of the ConfigurationCollectionAttribute class.

Properties

	Name	Description
	AddItemName	Gets or sets the name of the <add> configuration element.
	ClearItemsName	Gets or sets the name for the <clear> configuration element.
	CollectionType	Gets or sets the type of the ConfigurationCollectionAttribute attribute.
	ItemType	Gets the type of the collection element.
	RemoveItemName	Gets or sets the name for the <remove> configuration element.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

Methods

	Name	Description
	Equals(Object^)	This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)
	GetHashCode()	Returns the hash code for this instance.(Inherited from Attribute.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)
	Match(Object^)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	_Attribute::GetIDsOfNames(Guid%, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)
	_Attribute::GetTypeInfo(UInt32, UInt32, IntPtr)	Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)
	_Attribute::GetTypeInfoCount(UInt32%)	Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)
	_Attribute::Invoke(UInt32, Guid%, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

You use the ConfigurationCollectionAttribute attribute to decorate a ConfigurationElementCollection element. This instructs the .NET Framework to create an instance of the collection and to initialize it using your custom ConfigurationElement values.

Note
The simplest way to create a custom configuration element is to use the attributed (declarative) model. You declare the elements and decorate them with the ConfigurationCollectionAttribute attribute. For each element marked with this attribute, the .NET Framework uses reflection to read the decorating parameters and create a related ConfigurationElementCollection instance. You can also use the programmatic model. In this case it is your responsibility to declare the custom public collection but also to override the ConfigurationElementCollection member and return the properties collection.

Note

The simplest way to create a custom configuration element is to use the attributed (declarative) model. You declare the elements and decorate them with the ConfigurationCollectionAttribute attribute. For each element marked with this attribute, the .NET Framework uses reflection to read the decorating parameters and create a related ConfigurationElementCollection instance. You can also use the programmatic model. In this case it is your responsibility to declare the custom public collection but also to override the ConfigurationElementCollection member and return the properties collection.

The .NET Framework configuration system provides attribute types that you can use during the creation of custom configuration elements. There are two kinds of attributes:

The attributes that instruct the .NET Framework how to create instances of the custom configuration element properties. These types include:
- ConfigurationCollectionAttribute
- ConfigurationPropertyAttribute
The attributes that instruct the .NET Framework how to validate the custom configuration element properties. These types include:

Examples

The following example shows how to use the ConfigurationCollectionAttribute.

This example consists of three classes: UrlsSection, UrlsCollection and UrlConfigElement.The UrlsSection class uses the ConfigurationCollectionAttribute to define a custom configuration section. This section contains a URL collection (defined by the UrlsCollection class) of URL elements (defined by the UrlConfigElement class). When you run the example, an instance of the UrlsSection class is created and the following configuration elements are generated in the application configuration file:

<configuration>
    <configSections>
        <section name="MyUrls" type="UrlsSection, 
          ConfigurationCollectionAttribute, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
    </configSections>
    <MyUrls>
        <urls>
            <remove name="Contoso" />
            <add name="Contoso" url="http://www.contoso.com" port="0" />
        </urls>
    </MyUrls>
</configuration

C++

No code example is currently available or this language may not be supported.

C++

No code example is currently available or this language may not be supported.