IsKey Property

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
Available since 2.0
Return to top
Show:
© 2016 Microsoft