Edit

ConfigurationProperty.IsKey Property

  • Reference

Definition

Namespace:
System.Configuration
Assembly:
System.Configuration.ConfigurationManager.dll
Assembly:
System.Configuration.dll
Package:
System.Configuration.ConfigurationManager v6.0.0
Package:
System.Configuration.ConfigurationManager v7.0.0
Package:
System.Configuration.ConfigurationManager v8.0.0
Package:
System.Configuration.ConfigurationManager v9.0.0-preview.3.24172.9
Source:
ConfigurationProperty.cs
Source:
ConfigurationProperty.cs
Source:
ConfigurationProperty.cs
Source:
ConfigurationProperty.cs

Gets a value indicating whether this ConfigurationProperty is the key for the containing ConfigurationElement object.

This API supports the product infrastructure and is not intended to be used directly from your code.

public:
 property bool IsKey { bool get(); };
public bool IsKey { get; }
member this.IsKey : bool
Public ReadOnly Property IsKey As Boolean

Property Value

Boolean

true if this ConfigurationProperty object is the key for the containing element; otherwise, false. The default is false.

Examples

The following code example shows how to get the IsKey property for a specified property.

string isKey = _MaxIdleTime.IsKey.ToString();
Console.WriteLine("MaxIdleTime is key: {0}", isKey);

Dim isKey As String = _
_MaxIdleTime.IsKey.ToString()
Console.WriteLine( _
"MaxIdleTime is key: {0}", isKey)

Remarks

You can define a new ConfigurationProperty object to be the key for the containing element when implementing the ConfigurationElement element. If this flag is not used, the IsKey property will return false.

Applies to

See also