ConfigurationElement.LockAttributes Property

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Package:

System.Configuration.ConfigurationManager v9.0.0-rc.2.24473.5

Source:

ConfigurationElement.cs

Gets the collection of locked attributes.

public:
 property System::Configuration::ConfigurationLockCollection ^ LockAttributes { System::Configuration::ConfigurationLockCollection ^ get(); };

public System.Configuration.ConfigurationLockCollection LockAttributes { get; }

member this.LockAttributes : System.Configuration.ConfigurationLockCollection

Public ReadOnly Property LockAttributes As ConfigurationLockCollection

Property Value

ConfigurationLockCollection

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

Examples

The following example shows how to use the LockAttributes property.

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

' 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

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.

Note

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 Inheritors

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

See also

• ConfigurationLockCollection