Gets the collection of locked attributes
Namespace:
System.Configuration
Assembly:
System.Configuration (in System.Configuration.dll)
Visual Basic (Declaration)
Public ReadOnly Property LockAttributes As ConfigurationLockCollection
Dim instance As ConfigurationElement
Dim value As ConfigurationLockCollection
value = instance.LockAttributes
public ConfigurationLockCollection LockAttributes { get; }
public:
property ConfigurationLockCollection^ LockAttributes {
ConfigurationLockCollection^ get ();
}
public function get LockAttributes () : ConfigurationLockCollection
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 Implementers: 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
// 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());
}
}
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5, 3.0, 2.0
Reference