Click to Rate and Give Feedback
MSDN
MSDN Library
.NET Development
.NET Framework 3.5
 LockElements Property

  Switch on low bandwidth view
This page is specific to
Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:
.NET Framework Class Library
ConfigurationElement..::.LockElements Property

Gets the collection of locked elements.

Namespace:  System.Configuration
Assembly:  System.Configuration (in System.Configuration.dll)
Visual Basic (Declaration)
Public ReadOnly Property LockElements As ConfigurationLockCollection
Visual Basic (Usage)
Dim instance As ConfigurationElement
Dim value As ConfigurationLockCollection

value = instance.LockElements
C#
public ConfigurationLockCollection LockElements { get; }
Visual C++
public:
property ConfigurationLockCollection^ LockElements {
    ConfigurationLockCollection^ get ();
}
JScript
public function get LockElements () : ConfigurationLockCollection

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.

Visual Basic
' Show how to use LockElements
' It locks and unlocks the urls element.
Shared Sub LockElements()

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

        ' Get the MyUrls section.
        Dim myUrlsSection As UrlsSection = _
        config.GetSection("MyUrls")

        If myUrlsSection Is Nothing Then
            Console.WriteLine("Failed to load UrlsSection.")
        Else
            ' Get MyUrls section LockElements collection.
            Dim lockElements _
            As ConfigurationLockCollection = _
            myUrlsSection.LockElements

            ' Get MyUrls section LockElements collection 
            ' enumerator.
            Dim lockElementEnum As IEnumerator = _
            lockElements.GetEnumerator()

            ' Position the collection index.
            lockElementEnum.MoveNext()

            If lockElements.Contains("urls") Then
                ' Remove the lock on the urls element.
                lockElements.Remove("urls")
            Else
                ' Add the lock on the urls element.
                lockElements.Add("urls")
            End If
            ' Save the change.
            config.Save(ConfigurationSaveMode.Full)
        End If

    Catch err As ConfigurationErrorsException
        Console.WriteLine("[LockElements: {0}]", _
        err.ToString())
    End Try

End Sub 'LockElements


C#
// 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());
    }
}


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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2009 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker