ElementInformation.IsLocked Property

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Source:

ElementInformation.cs

Gets a value that indicates whether the associated ConfigurationElement object cannot be modified.

public:
 property bool IsLocked { bool get(); };

public bool IsLocked { get; }

member this.IsLocked : bool

Public ReadOnly Property IsLocked As Boolean

Property Value

Boolean

true if the associated ConfigurationElement object cannot be modified; otherwise, false.

Examples

The following example shows how to use the IsLocked property.

static public void IsElementLocked()
{
    // Get the current configuration file.
    System.Configuration.Configuration config =
            ConfigurationManager.OpenExeConfiguration(
            ConfigurationUserLevel.None);
    
    // Get the section.
    UrlsSection section =
        (UrlsSection)config.GetSection("MyUrls");

    // Get the element.
    UrlConfigElement url = section.Simple;

    bool isLocked =
        url.ElementInformation.IsLocked;
    Console.WriteLine("Url element is locked? {0}",
        isLocked.ToString());
}

Public Shared Sub IsElementLocked() 

    ' Get the current configuration file.
    Dim config _
    As System.Configuration.Configuration = _
    ConfigurationManager.OpenExeConfiguration( _
    ConfigurationUserLevel.None)

    ' Get the section.
    Dim section As UrlsSection = _
    CType(config.GetSection("MyUrls"), UrlsSection)
    
    ' Get the element.
    Dim url As UrlConfigElement = _
    section.Simple
    
    Dim isLocked As Boolean = _
    url.ElementInformation.IsLocked
    Console.WriteLine("Url element is locked? {0}", _
    isLocked.ToString())

End Sub

Remarks

The IsLocked property returns true when the related element is locked by the AllowOverride, AllowDefinition, or LockAllAttributesExcept property.