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)
'Declaration
Public ReadOnly Property LockElements As 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.

    ' 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

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft. All rights reserved.