AppSettingsSection.Settings Property

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Package:

System.Configuration.ConfigurationManager v8.0.0

Source:

AppSettingsSection.cs

Gets a collection of key/value pairs that contains application settings.

public:
 property System::Configuration::KeyValueConfigurationCollection ^ Settings { System::Configuration::KeyValueConfigurationCollection ^ get(); };

[System.Configuration.ConfigurationProperty("", IsDefaultCollection=true)]
public System.Configuration.KeyValueConfigurationCollection Settings { get; }

[<System.Configuration.ConfigurationProperty("", IsDefaultCollection=true)>]
member this.Settings : System.Configuration.KeyValueConfigurationCollection

Public ReadOnly Property Settings As KeyValueConfigurationCollection

Property Value

KeyValueConfigurationCollection

A collection of key/value pairs that contains the application settings from the configuration file.

Attributes

ConfigurationPropertyAttribute

Examples

The following example uses the Settings property to read the appSettings values.

// This function shows how to read the key/value
// pairs (settings collection)contained in the 
// appSettings section.
static void ReadAppSettings()
{
    try
    {

        // Get the configuration file.
        System.Configuration.Configuration config =
            ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);

        // Get the appSettings section.
        System.Configuration.AppSettingsSection appSettings =
            (System.Configuration.AppSettingsSection)config.GetSection("appSettings");

        // Get the auxiliary file name.
        Console.WriteLine("Auxiliary file: {0}", config.AppSettings.File);

        // Get the settings collection (key/value pairs).
        if (appSettings.Settings.Count != 0)
        {
            foreach (string key in appSettings.Settings.AllKeys)
            {
                string value = appSettings.Settings[key].Value;
                Console.WriteLine("Key: {0} Value: {1}", key, value);
            }
        }
        else
        {
            Console.WriteLine("The appSettings section is empty. Write first.");
        }
    }
    catch (Exception e)
    {
        Console.WriteLine("Exception raised: {0}",
            e.Message);
    }
}

' This function shows how to read the key/value
' pairs (settings collection)contained in the 
' appSettings section.
Private Shared Sub ReadAppSettings()
    Try

        ' Get the configuration file.
        Dim config As System.Configuration.Configuration = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None)

        ' Get the appSettings section.
        Dim appSettings As System.Configuration.AppSettingsSection = CType(config.GetSection("appSettings"), System.Configuration.AppSettingsSection)

        ' Get the auxiliary file name.
        Console.WriteLine("Auxiliary file: {0}", config.AppSettings.File)


        ' Get the settings collection (key/value pairs).
        If appSettings.Settings.Count <> 0 Then
            For Each key As String In appSettings.Settings.AllKeys
                Dim value As String = appSettings.Settings(key).Value
                Console.WriteLine("Key: {0} Value: {1}", key, value)
            Next key
        Else
            Console.WriteLine("The appSettings section is empty. Write first.")
        End If
    Catch e As Exception
        Console.WriteLine("Exception raised: {0}", e.Message)
    End Try
End Sub

' This function shows how to read the key/value
' pairs (settings collection)contained in the 
' appSettings section.
Private Shared Sub ReadAppSettings()
    Try

        ' Get the configuration file.
        Dim config As System.Configuration.Configuration = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None)

        ' Get the appSettings section.
        Dim appSettings As System.Configuration.AppSettingsSection = CType(config.GetSection("appSettings"), System.Configuration.AppSettingsSection)

        ' Get the auxiliary file name.
        Console.WriteLine("Auxiliary file: {0}", config.AppSettings.File)


        ' Get the settings collection (key/value pairs).
        If appSettings.Settings.Count <> 0 Then
            For Each key As String In appSettings.Settings.AllKeys
                Dim value As String = appSettings.Settings(key).Value
                Console.WriteLine("Key: {0} Value: {1}", key, value)
            Next key
        Else
            Console.WriteLine("The appSettings section is empty. Write first.")
        End If
    Catch e As Exception
        Console.WriteLine("Exception raised: {0}", e.Message)
    End Try
End Sub