ConfigurationElement.LockAttributes プロパティ

.NET Framework クラス ライブラリ リファレンス

ConfigurationElement.LockAttributes プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

ロックされている属性のコレクションを取得します。

名前空間: System.Configuration
アセンブリ: System.Configuration (system.configuration.dll 内)
構文

Visual Basic (宣言)

Public ReadOnly Property
 LockAttributes As ConfigurationLockCollection

Visual Basic (使用法)

Dim instance As ConfigurationElement
Dim value As ConfigurationLockCollection

value = instance.LockAttributes

C#

public ConfigurationLockCollection LockAttributes { get;
 }

C++

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

J#

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

JScript

public function get LockAttributes
 () : ConfigurationLockCollection

プロパティ値
要素のロックされている属性 (プロパティ) の ConfigurationLockCollection。

解説

LockAttributes プロパティを使用すると、指定したすべての属性をロックできます。

これを行うには、次の例に示すように、Contains メソッドを使用します。

メモ
LockAttributes プロパティを使用すると、規則の適用先要素の子構成要素が変更されないようにできます。要素自体およびその子要素に対して汎用的なロックを実行する場合は、LockItem を使用します。

実装時の注意 LockAllAttributesExcept プロパティと LockAttributes プロパティを同時に使用すると、最も厳しい規則が適用されることに注意してください。

使用例

LockAttributes プロパティを使用する方法の例を次に示します。

Visual Basic

' 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

C#

// 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 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ConfigurationElement クラス
ConfigurationElement メンバ
System.Configuration 名前空間
ConfigurationLockCollection