ConfigurationElement.LockAllElementsExcept 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 elements.

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

public System.Configuration.ConfigurationLockCollection LockAllElementsExcept { get; }

member this.LockAllElementsExcept : System.Configuration.ConfigurationLockCollection

Public ReadOnly Property LockAllElementsExcept As ConfigurationLockCollection

Property Value

ConfigurationLockCollection

The ConfigurationLockCollection of locked elements.

Examples

The following example shows how to use the LockAllElementsExcept property.

// Show how to use LockAllElementsExcept.
// It locks and unlocks all the MyUrls elements 
// except urls.
static void LockAllElementsExcept()
{

    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 lockElementsExcept =
                myUrlsSection.LockAllElementsExcept;

            // Get MyUrls section LockElements collection 
            // enumerator.
            IEnumerator lockElementEnum =
                 lockElementsExcept.GetEnumerator();

            // Position the collection index.
            lockElementEnum.MoveNext();

            if (lockElementsExcept.Contains("urls"))
                // Remove the lock on all the ther elements.
                lockElementsExcept.Remove("urls");
            else
                // Add the lock on all the other elements 
                // but urls element.
                lockElementsExcept.Add("urls");

            config.Save(ConfigurationSaveMode.Full);
        }
    }
    catch (ConfigurationErrorsException err)
    {
        Console.WriteLine("[LockAllElementsExcept: {0}]",
            err.ToString());
    }
}

' Show how to use LockAllElementsExcept.
' It locks and unlocks all the MyUrls elements 
' except urls.
Shared Sub LockAllElementsExcept()

    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 lockElementsExcept _
            As ConfigurationLockCollection = _
            myUrlsSection.LockAllElementsExcept

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

            ' Position the collection index.
            lockElementEnum.MoveNext()

            If lockElementsExcept.Contains("urls") Then
                ' Remove the lock on all the ther elements.
                lockElementsExcept.Remove("urls")
                ' Add the lock on all the other elements 
                ' but urls element.
            Else
                lockElementsExcept.Add("urls")
            End If

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

End Sub

Remarks

The LockAllElementsExcept property allows you to lock all the elements at once, except for the one you specify.

Note

The LockAllElementsExcept property allows you to prevent the child configuration elements of the element to which you apply the rule from being modified. Use the LockItem property if you want to put a general lock on the element itself and its child elements.

See also

• ConfigurationLockCollection