Export (0) Print
Expand All

ConfigurationElement.LockAttributes Property

Note: This property is new in the .NET Framework version 2.0.

Gets the collection of locked attributes

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

'Declaration
Public ReadOnly Property LockAttributes As ConfigurationLockCollection
'Usage
Dim instance As ConfigurationElement
Dim value As ConfigurationLockCollection

value = instance.LockAttributes

/** @property */
public ConfigurationLockCollection get_LockAttributes ()

public function get LockAttributes () : ConfigurationLockCollection

Property Value

The ConfigurationLockCollection of locked attributes (properties) for the element.

The LockAttributes property allows you to lock all the attributes you specify.

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

NoteNote

The LockAttributes 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 children.

Notes to Implementers Remember, if you use the LockAllAttributesExcept and LockAttributes properties at the same time, the most restrictive rule applies.

The following example shows how to use the LockAttributes property.

' Show how to use LockAttributes.
' It locks and unlocks all the urls elements.
Shared Sub LockAttributes() 
    
    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
            
            Dim elemEnum As IEnumerator = _
            myUrlsSection.Urls.GetEnumerator()
            
            Dim i As Integer = 0
            While elemEnum.MoveNext()    
                ' Get the current element.
                Dim element As ConfigurationElement = _
                myUrlsSection.Urls(i)

                ' Get the lock attributes collection of 
                ' the current element.
                Dim lockAttributes _
                As ConfigurationLockCollection = _
                element.LockAttributes

                ' Add or remove the lock on the attributes.
                If lockAttributes.Contains("name") Then
                    lockAttributes.Remove("name")
                Else
                    lockAttributes.Add("name")
                End If
                If lockAttributes.Contains("url") Then
                    lockAttributes.Remove("url")
                Else
                    lockAttributes.Add("url")
                End If
                If lockAttributes.Contains("port") Then
                    lockAttributes.Remove("port")
                Else
                    lockAttributes.Add("port")
                End If

                ' Get the locket attributes.
                Dim lockedAttributes As String = _
                lockAttributes.AttributeList()

                Console.WriteLine("Element {0 Locked attributes list: {1", _
                i.ToString(), lockedAttributes)

                i += 1

                config.Save(ConfigurationSaveMode.Full)
            End While
        End If
    
    Catch e As ConfigurationErrorsException
        Console.WriteLine("[LockAttributes: {0]", _
        e.ToString())
    End Try

End Sub 'LockAttributes


Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2015 Microsoft