.NET Framework Class Library
ConfigurationElementLockAttributes Property

Gets the collection of locked attributes

Namespace:   System.Configuration
Assembly:  System.Configuration (in System.Configuration.dll)
Syntax
Public ReadOnly Property LockAttributes As [%$TOPIC/ms134148_en-us_VS_110_1_0_0_0_0%]
public [%$TOPIC/ms134148_en-us_VS_110_1_0_1_0_0%] LockAttributes { get; }
public:
property [%$TOPIC/ms134148_en-us_VS_110_1_0_2_0_0%]^ LockAttributes {
	[%$TOPIC/ms134148_en-us_VS_110_1_0_2_0_1%]^ get ();
}
member LockAttributes : [%$TOPIC/ms134148_en-us_VS_110_1_0_3_0_0%] with get

Property Value

Type: System.ConfigurationConfigurationLockCollection
The ConfigurationLockCollection of locked attributes (properties) for the element.
Remarks

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

To do that you use the Contains method, as explained in the Example section.

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 child elements.

Notes to Implementers

If you use the LockAllAttributesExcept and LockAttributes properties at the same time, the most restrictive rule applies.

Examples

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
// Show how to use LockAttributes. 
// It locks and unlocks all the urls elements. 
static void LockAttributes()
{

    try
    {
        // Get the current 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
        {

            IEnumerator elemEnum =
                 myUrlsSection.Urls.GetEnumerator();

            int i = 0;
            while (elemEnum.MoveNext())
            {

                // Get the current element.
                ConfigurationElement element =
                    myUrlsSection.Urls[i];

                // Get the lock attributes collection of  
                // the current element.
                ConfigurationLockCollection lockAttributes =
                    element.LockAttributes;

                // Add or remove the lock on the attributes. 
                if (lockAttributes.Contains("name"))
                    lockAttributes.Remove("name");
                else
                    lockAttributes.Add("name");

                if (lockAttributes.Contains("url"))
                    lockAttributes.Remove("url");
                else
                    lockAttributes.Add("url");

                if (lockAttributes.Contains("port"))
                    lockAttributes.Remove("port");
                else
                    lockAttributes.Add("port");


                // Get the locket attributes. 
                string lockedAttributes =
                    lockAttributes.AttributeList;

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

                i += 1;

                config.Save(ConfigurationSaveMode.Full);

            }

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

}
Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

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.