AppSettingsSection Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Poskytuje podporu konfiguračního appSettings
systému pro oddíl konfigurace. Tato třída se nemůže dědit.
public ref class AppSettingsSection sealed : System::Configuration::ConfigurationSection
public sealed class AppSettingsSection : System.Configuration.ConfigurationSection
type AppSettingsSection = class
inherit ConfigurationSection
Public NotInheritable Class AppSettingsSection
Inherits ConfigurationSection
- Dědičnost
Příklady
Následující příklad ukazuje, jak použít AppSettingsSection třídu v konzolové aplikaci. Čte a zapisuje páry klíč/hodnota obsažené v oddílu appSettings
. Také ukazuje, jak získat přístup File k vlastnosti AppSettingsSection třídy .
Poznámka
Před kompilací tohoto kódu přidejte do projektu odkaz na System.Configuration.dll.
using System;
using System.Collections.Specialized;
using System.Configuration;
using System.Text;
using System.IO;
// IMPORTANT: To compile this example, you must add to the project
// a reference to the System.Configuration assembly.
//
class UsingAppSettingsSection
{
#region UsingAppSettingsSection
// This function shows how to use the File property of the
// appSettings section.
// The File property is used to specify an auxiliary
// configuration file.
// Usually you create an auxiliary file off-line to store
// additional settings that you can modify as needed without
// causing an application restart,as in the case of a Web
// application.
// These settings are then added to the ones defined in the
// application configuration file.
static void IntializeConfigurationFile()
{
// Create a set of unique key/value pairs to store in
// the appSettings section of an auxiliary configuration
// file.
string time1 = String.Concat(DateTime.Now.ToLongDateString(),
" ", DateTime.Now.ToLongTimeString());
string time2 = String.Concat(DateTime.Now.ToLongDateString(),
" ", new DateTime(2009, 06, 30).ToLongTimeString());
string[] buffer = {"<appSettings>",
"<add key='AuxAppStg0' value='" + time1 + "'/>",
"<add key='AuxAppStg1' value='" + time2 + "'/>",
"</appSettings>"};
// Create an auxiliary configuration file and store the
// appSettings defined before.
// Note creating a file at run-time is just for demo
// purposes to run this example.
File.WriteAllLines("auxiliaryFile.config", buffer);
// Get the current configuration associated
// with the application.
System.Configuration.Configuration config =
ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
// Associate the auxiliary with the default
// configuration file.
System.Configuration.AppSettingsSection appSettings = config.AppSettings;
appSettings.File = "auxiliaryFile.config";
// Save the configuration file.
config.Save(ConfigurationSaveMode.Modified);
// Force a reload in memory of the
// changed section.
ConfigurationManager.RefreshSection("appSettings");
}
// This function shows how to write a key/value
// pair to the appSettings section.
static void WriteAppSettings()
{
try
{
// Get the application configuration file.
System.Configuration.Configuration config =
ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
// Create a unique key/value pair to add to
// the appSettings section.
string keyName = "AppStg" + config.AppSettings.Settings.Count;
string value = string.Concat(DateTime.Now.ToLongDateString(),
" ", DateTime.Now.ToLongTimeString());
// Add the key/value pair to the appSettings
// section.
// config.AppSettings.Settings.Add(keyName, value);
System.Configuration.AppSettingsSection appSettings = config.AppSettings;
appSettings.Settings.Add(keyName, value);
// Save the configuration file.
config.Save(ConfigurationSaveMode.Modified);
// Force a reload in memory of the changed section.
// This to read the section with the
// updated values.
ConfigurationManager.RefreshSection("appSettings");
Console.WriteLine(
"Added the following Key: {0} Value: {1} .", keyName, value);
}
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.
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);
}
}
#endregion UsingAppSettingsSection
#region ApplicationMain
// This class obtains user's input and provide feedback.
// It contains the application Main.
class ApplicationMain
{
// Display user's menu.
public static void UserMenu()
{
StringBuilder buffer = new StringBuilder();
buffer.AppendLine("Please, make your selection.");
buffer.AppendLine("1 -- Write appSettings section.");
buffer.AppendLine("2 -- Read appSettings section.");
buffer.AppendLine("? -- Display help.");
buffer.AppendLine("Q,q -- Exit the application.");
Console.Write(buffer.ToString());
}
// Obtain user's input and provide
// feedback.
static void Main(string[] args)
{
// Define user selection string.
string selection;
// Get the name of the application.
string appName =
Environment.GetCommandLineArgs()[0];
IntializeConfigurationFile();
// Get user selection.
while (true)
{
UserMenu();
Console.Write("> ");
selection = Console.ReadLine();
if (!string.IsNullOrEmpty(selection))
break;
}
while (selection.ToLower() != "q")
{
// Process user's input.
switch (selection)
{
case "1":
WriteAppSettings();
break;
case "2":
ReadAppSettings();
break;
default:
UserMenu();
break;
}
Console.Write("> ");
selection = Console.ReadLine();
}
}
}
#endregion ApplicationMain
}
Imports System.Collections.Specialized
Imports System.Configuration
Imports System.Text
Imports System.IO
' IMPORTANT: To compile this example, you must add to the project
' a reference to the System.Configuration assembly.
'
Class UsingAppSettingsSection
#Region "UsingAppSettingsSection"
' This function shows how to use the File property of the
' appSettings section.
' The File property is used to specify an auxiliary
' configuration file.
' Usually you create an auxiliary file off-line to store
' additional settings that you can modify as needed without
' causing an application restart,as in the case of a Web
' application.
' These settings are then added to the ones defined in the
' application configuration file.
Private Shared Sub IntializeConfigurationFile()
' Create a set of unique key/value pairs to store in
' the appSettings section of an auxiliary configuration
' file.
Dim time1 As String = String.Concat(Date.Now.ToLongDateString(), " ", Date.Now.ToLongTimeString())
Dim time2 As String = String.Concat(Date.Now.ToLongDateString(), " ", New Date(2009, 6, 30).ToLongTimeString())
Dim buffer() As String = {"<appSettings>", "<add key='AuxAppStg0' value='" & time1 & "'/>", "<add key='AuxAppStg1' value='" & time2 & "'/>", "</appSettings>"}
' Create an auxiliary configuration file and store the
' appSettings defined before.
' Note creating a file at run-time is just for demo
' purposes to run this example.
File.WriteAllLines("auxiliaryFile.config", buffer)
' Get the current configuration associated
' with the application.
Dim config As System.Configuration.Configuration = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None)
' Associate the auxiliary with the default
' configuration file.
Dim appSettings As System.Configuration.AppSettingsSection = config.AppSettings
appSettings.File = "auxiliaryFile.config"
' Save the configuration file.
config.Save(ConfigurationSaveMode.Modified)
' Force a reload in memory of the
' changed section.
ConfigurationManager.RefreshSection("appSettings")
End Sub
' This function shows how to write a key/value
' pair to the appSettings section.
Private Shared Sub WriteAppSettings()
Try
' Get the application configuration file.
Dim config As System.Configuration.Configuration = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None)
' Create a unique key/value pair to add to
' the appSettings section.
Dim keyName As String = "AppStg" & config.AppSettings.Settings.Count
Dim value As String = String.Concat(Date.Now.ToLongDateString(), " ", Date.Now.ToLongTimeString())
' Add the key/value pair to the appSettings
' section.
' config.AppSettings.Settings.Add(keyName, value);
Dim appSettings As System.Configuration.AppSettingsSection = config.AppSettings
appSettings.Settings.Add(keyName, value)
' Save the configuration file.
config.Save(ConfigurationSaveMode.Modified)
' Force a reload in memory of the changed section.
' This to read the section with the
' updated values.
ConfigurationManager.RefreshSection("appSettings")
Console.WriteLine("Added the following Key: {0} Value: {1} .", keyName, value)
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
#End Region ' UsingAppSettingsSection
#Region "ApplicationMain"
Shared Sub UserMenu()
Dim buffer As New StringBuilder()
buffer.AppendLine("Please, make your selection.")
buffer.AppendLine("1 -- Write appSettings section.")
buffer.AppendLine("2 -- Read appSettings section.")
buffer.AppendLine("? -- Display help.")
buffer.AppendLine("Q,q -- Exit the application.")
Console.Write(buffer.ToString())
End Sub
' Obtain user's input and provide
' feedback.
Shared Sub Main(ByVal args() As String)
' Define user selection string.
Dim selection As String
' Get the name of the application.
Dim appName As String = Environment.GetCommandLineArgs()(0)
IntializeConfigurationFile()
' Get user selection.
Do
UserMenu()
Console.Write("> ")
selection = Console.ReadLine()
If selection <> String.Empty Then
Exit Do
End If
Loop
Do While selection.ToLower() <> "q"
' Process user's input.
Select Case selection
Case "1"
WriteAppSettings()
Case "2"
ReadAppSettings()
Case Else
UserMenu()
End Select
Console.Write("> ")
selection = Console.ReadLine()
Loop
End Sub
' End Class
#End Region ' ApplicationMain
End Class
Imports System.Collections.Specialized
Imports System.Configuration
Imports System.Text
Imports System.IO
' IMPORTANT: To compile this example, you must add to the project
' a reference to the System.Configuration assembly.
'
Class UsingAppSettingsSection
#Region "UsingAppSettingsSection"
' This function shows how to use the File property of the
' appSettings section.
' The File property is used to specify an auxiliary
' configuration file.
' Usually you create an auxiliary file off-line to store
' additional settings that you can modify as needed without
' causing an application restart,as in the case of a Web
' application.
' These settings are then added to the ones defined in the
' application configuration file.
Private Shared Sub IntializeConfigurationFile()
' Create a set of unique key/value pairs to store in
' the appSettings section of an auxiliary configuration
' file.
Dim time1 As String = String.Concat(Date.Now.ToLongDateString(), " ", Date.Now.ToLongTimeString())
Dim time2 As String = String.Concat(Date.Now.ToLongDateString(), " ", New Date(2009, 6, 30).ToLongTimeString())
Dim buffer() As String = {"<appSettings>", "<add key='AuxAppStg0' value='" & time1 & "'/>", "<add key='AuxAppStg1' value='" & time2 & "'/>", "</appSettings>"}
' Create an auxiliary configuration file and store the
' appSettings defined before.
' Note creating a file at run-time is just for demo
' purposes to run this example.
File.WriteAllLines("auxiliaryFile.config", buffer)
' Get the current configuration associated
' with the application.
Dim config As System.Configuration.Configuration = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None)
' Associate the auxiliary with the default
' configuration file.
Dim appSettings As System.Configuration.AppSettingsSection = config.AppSettings
appSettings.File = "auxiliaryFile.config"
' Save the configuration file.
config.Save(ConfigurationSaveMode.Modified)
' Force a reload in memory of the
' changed section.
ConfigurationManager.RefreshSection("appSettings")
End Sub
' This function shows how to write a key/value
' pair to the appSettings section.
Private Shared Sub WriteAppSettings()
Try
' Get the application configuration file.
Dim config As System.Configuration.Configuration = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None)
' Create a unique key/value pair to add to
' the appSettings section.
Dim keyName As String = "AppStg" & config.AppSettings.Settings.Count
Dim value As String = String.Concat(Date.Now.ToLongDateString(), " ", Date.Now.ToLongTimeString())
' Add the key/value pair to the appSettings
' section.
' config.AppSettings.Settings.Add(keyName, value);
Dim appSettings As System.Configuration.AppSettingsSection = config.AppSettings
appSettings.Settings.Add(keyName, value)
' Save the configuration file.
config.Save(ConfigurationSaveMode.Modified)
' Force a reload in memory of the changed section.
' This to read the section with the
' updated values.
ConfigurationManager.RefreshSection("appSettings")
Console.WriteLine("Added the following Key: {0} Value: {1} .", keyName, value)
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
#End Region ' UsingAppSettingsSection
#Region "ApplicationMain"
Shared Sub UserMenu()
Dim buffer As New StringBuilder()
buffer.AppendLine("Please, make your selection.")
buffer.AppendLine("1 -- Write appSettings section.")
buffer.AppendLine("2 -- Read appSettings section.")
buffer.AppendLine("? -- Display help.")
buffer.AppendLine("Q,q -- Exit the application.")
Console.Write(buffer.ToString())
End Sub
' Obtain user's input and provide
' feedback.
Shared Sub Main(ByVal args() As String)
' Define user selection string.
Dim selection As String
' Get the name of the application.
Dim appName As String = Environment.GetCommandLineArgs()(0)
IntializeConfigurationFile()
' Get user selection.
Do
UserMenu()
Console.Write("> ")
selection = Console.ReadLine()
If selection <> String.Empty Then
Exit Do
End If
Loop
Do While selection.ToLower() <> "q"
' Process user's input.
Select Case selection
Case "1"
WriteAppSettings()
Case "2"
ReadAppSettings()
Case Else
UserMenu()
End Select
Console.Write("> ")
selection = Console.ReadLine()
Loop
End Sub
' End Class
#End Region ' ApplicationMain
End Class
Poznámky
Oddíl appSettings
konfigurace obsahuje dvojice string
hodnot klíč/hodnota pro aplikaci. Místo přístupu k těmto hodnotám pomocí instance objektu AppSettingsSection byste měli použít AppSettings vlastnost ConfigurationManager třídy nebo AppSettings vlastnost WebConfigurationManager třídy.
Konstruktory
AppSettingsSection() |
Inicializuje novou instanci AppSettingsSection třídy . |
Vlastnosti
CurrentConfiguration |
Získá odkaz na instanci nejvyšší úrovně Configuration , která představuje hierarchii konfigurace, do které aktuální ConfigurationElement instance patří. (Zděděno od ConfigurationElement) |
ElementInformation |
ElementInformation Získá objekt, který obsahuje neuzpůsobitelné informace a funkce objektuConfigurationElement. (Zděděno od ConfigurationElement) |
ElementProperty |
ConfigurationElementProperty Získá objekt, který představuje ConfigurationElement objekt samotný. (Zděděno od ConfigurationElement) |
EvaluationContext |
ContextInformation Získá objekt pro ConfigurationElement objekt . (Zděděno od ConfigurationElement) |
File |
Získá nebo nastaví konfigurační soubor, který poskytuje další nastavení nebo přepíše nastavení zadané v elementu |
HasContext |
Získá hodnotu, která označuje, zda CurrentConfiguration je |
Item[ConfigurationProperty] |
Získá nebo nastaví vlastnost nebo atribut tohoto elementu konfigurace. (Zděděno od ConfigurationElement) |
Item[String] |
Získá nebo nastaví vlastnost, atribut nebo podřízený prvek tohoto elementu konfigurace. (Zděděno od ConfigurationElement) |
LockAllAttributesExcept |
Získá kolekci uzamčených atributů. (Zděděno od ConfigurationElement) |
LockAllElementsExcept |
Získá kolekci uzamčených prvků. (Zděděno od ConfigurationElement) |
LockAttributes |
Získá kolekci uzamčených atributů. (Zděděno od ConfigurationElement) |
LockElements |
Získá kolekci uzamčených prvků. (Zděděno od ConfigurationElement) |
LockItem |
Získá nebo nastaví hodnotu označující, zda je prvek uzamčen. (Zděděno od ConfigurationElement) |
Properties |
Získá kolekci vlastností. (Zděděno od ConfigurationElement) |
SectionInformation |
SectionInformation Získá objekt, který obsahuje neuzpůsobitelné informace a funkce objektuConfigurationSection. (Zděděno od ConfigurationSection) |
Settings |
Získá kolekci párů klíč/hodnota, která obsahuje nastavení aplikace. |
Metody
DeserializeElement(XmlReader, Boolean) |
Načte XML z konfiguračního souboru. (Zděděno od ConfigurationElement) |
DeserializeSection(XmlReader) |
Načte XML z konfiguračního souboru. (Zděděno od ConfigurationSection) |
Equals(Object) |
Porovná aktuální ConfigurationElement instanci se zadaným objektem. (Zděděno od ConfigurationElement) |
GetHashCode() |
Získá jedinečnou hodnotu představující aktuální ConfigurationElement instanci. (Zděděno od ConfigurationElement) |
GetRuntimeObject() |
Vrátí vlastní objekt při přepsání v odvozené třídě. (Zděděno od ConfigurationSection) |
GetTransformedAssemblyString(String) |
Vrátí transformovanou verzi zadaného názvu sestavení. (Zděděno od ConfigurationElement) |
GetTransformedTypeString(String) |
Vrátí transformovanou verzi zadaného názvu typu. (Zděděno od ConfigurationElement) |
GetType() |
Type Získá z aktuální instance. (Zděděno od Object) |
Init() |
ConfigurationElement Nastaví objekt do počátečního stavu. (Zděděno od ConfigurationElement) |
InitializeDefault() |
Slouží k inicializaci výchozí sady hodnot objektu ConfigurationElement . (Zděděno od ConfigurationElement) |
IsModified() |
Určuje, zda byl tento konfigurační prvek změněn od jeho posledního uložení nebo načtení při implementaci v odvozené třídě. (Zděděno od ConfigurationSection) |
IsReadOnly() |
Získá hodnotu označující, zda ConfigurationElement je objekt jen pro čtení. (Zděděno od ConfigurationElement) |
ListErrors(IList) |
Přidá chyby neplatné vlastnosti v tomto ConfigurationElement objektu a ve všech podelementech, do předaného seznamu. (Zděděno od ConfigurationElement) |
MemberwiseClone() |
Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object) |
OnDeserializeUnrecognizedAttribute(String, String) |
Získá hodnotu označující, zda je zjištěn neznámý atribut během deserializace. (Zděděno od ConfigurationElement) |
OnDeserializeUnrecognizedElement(String, XmlReader) |
Získá hodnotu označující, zda je zjištěn neznámý prvek během deserializace. (Zděděno od ConfigurationElement) |
OnRequiredPropertyNotFound(String) |
Vyvolá výjimku, pokud není nalezena požadovaná vlastnost. (Zděděno od ConfigurationElement) |
PostDeserialize() |
Volána po deserializaci. (Zděděno od ConfigurationElement) |
PreSerialize(XmlWriter) |
Volána před serializací. (Zděděno od ConfigurationElement) |
Reset(ConfigurationElement) |
Resetuje vnitřní stav objektu ConfigurationElement , včetně zámků a kolekcí vlastností. (Zděděno od ConfigurationElement) |
ResetModified() |
Resetuje hodnotu IsModified() metody na |
SerializeElement(XmlWriter, Boolean) |
Zapíše obsah tohoto konfiguračního prvku do konfiguračního souboru při implementaci v odvozené třídě. (Zděděno od ConfigurationElement) |
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) |
Vytvoří řetězec XML obsahující nesloučené zobrazení objektu ConfigurationSection jako jeden oddíl pro zápis do souboru. (Zděděno od ConfigurationSection) |
SerializeToXmlElement(XmlWriter, String) |
Zapíše vnější značky tohoto konfiguračního prvku do konfiguračního souboru při implementaci v odvozené třídě. (Zděděno od ConfigurationElement) |
SetPropertyValue(ConfigurationProperty, Object, Boolean) |
Nastaví vlastnost na zadanou hodnotu. (Zděděno od ConfigurationElement) |
SetReadOnly() |
IsReadOnly() Nastaví vlastnost objektu ConfigurationElement a všech dílčích elementů. (Zděděno od ConfigurationElement) |
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) |
Určuje, zda zadaný prvek má být serializován, když je hierarchie objektů konfigurace serializována pro zadanou cílovou verzi rozhraní .NET Framework. (Zděděno od ConfigurationSection) |
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) |
Určuje, zda má být zadaná vlastnost serializována, když je hierarchie objektů konfigurace serializována pro zadanou cílovou verzi rozhraní .NET Framework. (Zděděno od ConfigurationSection) |
ShouldSerializeSectionInTargetVersion(FrameworkName) |
Určuje, zda aktuální ConfigurationSection instance by měla být serializována, když je hierarchie objektů konfigurace serializována pro zadanou cílovou verzi rozhraní .NET Framework. (Zděděno od ConfigurationSection) |
ToString() |
Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object) |
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
Upraví objekt tak, ConfigurationElement aby odebral všechny hodnoty, které by neměly být uloženy. (Zděděno od ConfigurationElement) |