ConfigurationElement.IsModified メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

ConfigurationElement.IsModified メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

派生クラスに実装された場合、この構成要素が最後の保存または読み込み以降に変更されたかどうかを示します。

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

Visual Basic (宣言)

Protected Friend Overridable
 Function IsModified As Boolean

Visual Basic (使用法)

Dim returnValue As Boolean

returnValue = Me.IsModified

protected internal virtual bool IsModified
 ()

C++

protected public:
virtual bool IsModified ()

protected boolean IsModified ()

JScript

protected internal function
 IsModified () : boolean

戻り値
要素が変更された場合は true。それ以外の場合は false。

解説

IsModified メソッドは、Save メソッドが呼び出されたときにこの ConfigurationElement オブジェクトが構成ファイルに書き込まれるかどうかを確認します。戻り値が false の場合、構成ファイルが要素の現在の状態を表していると見なされます。

既定では、IsModified は、インデクサを通じてこの ConfigurationElement オブジェクトにプロパティが設定された後に true を返します。

この ConfigurationElement 要素の状態を示すカスタムの値を提供するには、IsModified メソッドをオーバーライドします。

使用例

IsModified を拡張する方法の例を次に示します。

Visual Basic

Protected Overrides Function
 IsModified() As Boolean 
    Dim ret As Boolean =
 MyBase.IsModified()
    
    ' Enter your custom processing code here.
    Console.WriteLine("UrlConfigElement.IsModified() called.")
    
    Return ret

End Function 'IsModified

protected override bool IsModified()
{
    bool ret = base.IsModified();

    // Enter your custom processing code here.

    Console.WriteLine("UrlConfigElement.IsModified() called.");

    return ret;
}

前述の例に示されているメソッドが、次の例では構成要素が変更されたときに呼び出されます。

Visual Basic

' Show how to use IsModified.
' This method modifies the port property
' of the url element named Microsoft and
' saves the modification to the configuration
' file. This in turn will cause the overriden
' UrlConfigElement.IsModified() mathod to be called. 
Shared Sub ModifyElement() 
    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")
        
        
        Dim elements As UrlsCollection = _
        myUrlsSection.Urls
        
        
        Dim elemEnum As IEnumerator = _
        elements.GetEnumerator()
        
        Dim i As Integer
 = 0
        While elemEnum.MoveNext()
            If elements(i).Name = "Microsoft"
 Then
                elements(i).Port = 1010
                Dim [readOnly] As Boolean
 = _
                elements(i).IsReadOnly()
                Exit While
            End If
            i += 1
        End While
        
        If Not myUrlsSection.ElementInformation.IsLocked
 Then
            
            config.Save(ConfigurationSaveMode.Full)
            
            ' This to obsolete the MyUrls cached 
            ' section and read the updated version 
            ' from the configuration file.
            ConfigurationManager.RefreshSection("MyUrls")
        Else
            Console.WriteLine("Section was locked, could not update.")
        End If
    
    Catch err As ConfigurationErrorsException
        Console.WriteLine("[ModifyElement: {0}]",
 _
        err.ToString())
    End Try

End Sub 'ModifyElement

// Show how to use IsModified.
// This method modifies the port property
// of the url element named Microsoft and
// saves the modification to the configuration
// file. This in turn will cause the overriden
// UrlConfigElement.IsModified() mathod to be called. 
static void ModifyElement()
{
    try
    {
        // Get the configuration file.
        System.Configuration.Configuration config =
            ConfigurationManager.OpenExeConfiguration(
            ConfigurationUserLevel.None);

        // Get the MyUrls section.
        UrlsSection myUrlsSection =
            config.GetSection("MyUrls") as UrlsSection;


        UrlsCollection elements = myUrlsSection.Urls;


        IEnumerator elemEnum =
            elements.GetEnumerator();

        int i = 0;
        while (elemEnum.MoveNext())
        {
            if (elements[i].Name == "Microsoft")
            {
                elements[i].Port = 1010;
                bool readOnly = elements[i].IsReadOnly();
                break;
            }
            i += 1;
        }

        if (!myUrlsSection.ElementInformation.IsLocked)
        {

            config.Save(ConfigurationSaveMode.Full);

            // This to obsolete the MyUrls cached 
            // section and read the updated version
            // from the configuration file.
            ConfigurationManager.RefreshSection("MyUrls");
        }
        else
            Console.WriteLine(
                "Section was locked, could not update.");
    }

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

}