ConfigurationProperty.IsKey Property

Definition

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 bool IsKey { get; }

Property Value

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);

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

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

See also