ConfigurationCollectionAttribute(Type) Constructor

Reference

Definition

Namespace:: System.Configuration

Assembly:: System.Configuration.ConfigurationManager.dll

Assembly:: System.Configuration.dll

Package:: System.Configuration.ConfigurationManager v10.0.0-preview.1.25080.5

Source:: ConfigurationCollectionAttribute.cs

Source:: ConfigurationCollectionAttribute.cs

Source:: ConfigurationCollectionAttribute.cs

Source:: ConfigurationCollectionAttribute.cs

Source:: ConfigurationCollectionAttribute.cs

Source:: ConfigurationCollectionAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Initializes a new instance of the ConfigurationCollectionAttribute class.

public:
 ConfigurationCollectionAttribute(Type ^ itemType);

public ConfigurationCollectionAttribute(Type itemType);

new System.Configuration.ConfigurationCollectionAttribute : Type -> System.Configuration.ConfigurationCollectionAttribute

Public Sub New (itemType As Type)

Parameters

itemType: Type

The type of the property collection to create.

Exceptions

ArgumentNullException

itemType is null.

Examples

The following example shows how to use the ConfigurationCollectionAttribute.

// Declare the Urls collection property using the
// ConfigurationCollectionAttribute.
// This allows to build a nested section that contains
// a collection of elements.
[ConfigurationProperty("urls", IsDefaultCollection = false)]
[ConfigurationCollection(typeof(UrlsCollection),
    AddItemName = "add",
    ClearItemsName = "clear",
    RemoveItemName = "remove")]
public UrlsCollection Urls
{
    get
    {
        UrlsCollection urlsCollection =
            (UrlsCollection)base["urls"];
        return urlsCollection;
    }
}

' Declare the Urls collection property using the
' ConfigurationCollectionAttribute.
' This allows to build a nested section that contains
' a collection of elements.
<ConfigurationProperty("urls", IsDefaultCollection:=False),
    System.Configuration.ConfigurationCollection(GetType(UrlsCollection),
    AddItemName:="add", ClearItemsName:="clear", RemoveItemName:="remove")> _
Public ReadOnly Property Urls() As UrlsCollection
    Get
        Dim urlsCollection As UrlsCollection = CType(MyBase.Item("urls"), UrlsCollection)
        Return urlsCollection
    End Get
End Property

Remarks

You use this constructor to tell the .NET Framework the custom type of the property collection to be created.

Applies to

Product	Versions
.NET	8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Framework	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, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0 (package-provided)
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via