ConfigurationPropertyAttribute.IsKey Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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 Property IsKey As Boolean

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 Property Name() As String
    Get
        Return CStr(Me("name"))
    End Get
    Set(ByVal value As String)
        Me("name") = value
    End Set
End Property

.NET Framework
Available since 2.0
Return to top
Show: