Export (0) Print
Expand All

ConfigurationPropertyAttribute.IsKey Property

Gets or sets a value indicating whether this is a key property for the decorated element property.

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

public bool IsKey { get; set; }

Property Value

Type: System.Boolean
true if the property is a key property for an element of the collection; otherwise, false. The default is false.

The IsKey property applies only if the property you decorate is a collection. It does not have any effect if the property is not a collection. Multiple elements can be marked as IsKey.

The following example shows how to use the IsKey property.

[ConfigurationProperty("name", DefaultValue = "Contoso",
    IsRequired = true, IsKey = true)]
public string Name
{
    get
    {
        return (string)this["name"];
    }
    set
    {
        this["name"] = value;
    }
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft