Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ConfigurationElement.LockElements Property

Gets the collection of locked elements.

Namespace:  System.Configuration
Assembly:  System.Configuration (in System.Configuration.dll)
public ConfigurationLockCollection LockElements { get; }

The LockElements property allows you to lock all the elements you specify.

To do that, you use the Contains method, as explained in the next example.

NoteNote

The LockElements property allows you to prevent the child configuration elements of the element to which you apply the rule from being modified. Use LockItem if you want to put a general lock on the element itself and its child elements.

The following example shows how to use the LockElements property.


        // Show how to use LockElements
        // It locks and unlocks the urls element.
        static void LockElements()
        {

            try
            {
                // Get the configuration file.
                System.Configuration.Configuration config =
                    ConfigurationManager.OpenExeConfiguration(
                    ConfigurationUserLevel.None);

                // Get the MyUrls section.
                UrlsSection myUrlsSection =
                    config.GetSection("MyUrls") as UrlsSection;

                if (myUrlsSection == null)
                    Console.WriteLine("Failed to load UrlsSection.");
                else
                {
                    // Get MyUrls section LockElements collection.
                    ConfigurationLockCollection lockElements =
                        myUrlsSection.LockElements;

                    // Get MyUrls section LockElements collection 
                    // enumerator.
                    IEnumerator lockElementEnum =
                         lockElements.GetEnumerator();

                    // Position the collection index.
                    lockElementEnum.MoveNext();

                    if (lockElements.Contains("urls"))
                        // Remove the lock on the urls element.
                        lockElements.Remove("urls");
                    else
                        // Add the lock on the urls element.
                        lockElements.Add("urls");

                    // Save the change.
                    config.Save(ConfigurationSaveMode.Full);

                }

            }
            catch (ConfigurationErrorsException err)
            {
                Console.WriteLine("[LockElements: {0}]",
                    err.ToString());
            }
        }



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.