ConfigurationElement.LockItem Property

Gets or sets a value indicating whether the element is locked.

Namespace: System.Configuration
Assembly: System.Configuration (in system.configuration.dll)

public bool LockItem { get; set; }
/** @property */
public boolean get_LockItem ()

/** @property */
public void set_LockItem (boolean value)

public function get LockItem () : boolean

public function set LockItem (value : boolean)

Not applicable.

Property Value

true if the element is locked; otherwise, false. The default is false.

Exception typeCondition


The element has already been locked at a higher configuration level.

Use the LockItem property if you want to put a general lock on the element itself and its child elements.

The following example shows how to use the LockItem.

// Show how to set LockItem
// It adds a new UrlConfigElement to 
// the collection.
static void LockItem()
    string name = "Contoso";
    string url = "";
    int port = 8080;

        // Get the current configuration file.
        System.Configuration.Configuration config =

        // Get the MyUrls section.
        UrlsSection myUrls =
           config.Sections["MyUrls"] as UrlsSection;

        // Create the new  element.
        UrlConfigElement newElement =
            new UrlConfigElement(name, url, port);

        // Set its lock.
        newElement.LockItem = true;

        // Save the new element to the 
        // configuration file.
        if (!myUrls.ElementInformation.IsLocked)



            // This is used to obsolete the cached 
            // section and read the updated 
            // bersion from the configuration file.
                "Section was locked, could not update.");

    catch (ConfigurationErrorsException e)
        Console.WriteLine("[LockItem: {0}]",


Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions