Element appSettings (schéma obecného nastavení)

Článek
08/11/2011

Obsahuje vlastní nastavení aplikace, jako například cesty k souborům, adresy URL webových služeb XML nebo další informace, které jsou uloženy v souboru INI dané aplikace.

<appSettings
   file="relative file name" >
</appSettings>

Atributy a prvky

Následující části popisují atributy, podřízené prvky a rodičovské prvky.

v případě vícehodnotových atributů

Prvek	Popis
file	Volitelný String atributu. Určuje relativní cestu k externímu souboru, který obsahuje vlastní nastavení konfigurace aplikace. Zadaný soubor obsahuje stejný druh nastavení, který se nachází v atributech appSettings add, clear a remove a používá pro tyto prvky stejný formát dvojic klíč/hodnota. Zadaná cesta je relativní k místnímu konfiguračnímu souboru. Pokud zadaný soubor nelze najít, běhové prostředí ignoruje atribut. Jelikož některé změny v souboru Web.config mohou zapříčinit restart aplikace, lze použít samostatné soubory umožňující uživatelům upravit hodnoty v sekci appSettings bez vynucení restartování aplikace. Obsah samostatného souboru je sloučen s oddílem appSettings souboru Web.config. Tato funkce je omezena atributem appSettings. POZNÁMKA V rozhraní .NET Framework verze 2.0 můžete vkládat nastavení konfigurace všech konfiguračních prvků, které podporují atribut configSource, do samostatného souboru. Nicméně, pokud použijete atribut configSource, je potřeba přesunout celý oddíl do samostatného souboru, jinak by žádná data nebyla sloučena. Zápis do souboru Web.config se provede jednorázově při použití atributu configSource. Toto sice způsobí restartování aplikace, ale následné aktualizace oddílu se zapisují přímo do samostatného soubor a nezpůsobí tak další restartování aplikace. Další informace naleznete v tématu ConfigSource.
Zděděné atributy	Volitelné atributy. Atributy, které jsou děděny všemi prvky oddílu.

file

Volitelný String atributu.

Určuje relativní cestu k externímu souboru, který obsahuje vlastní nastavení konfigurace aplikace. Zadaný soubor obsahuje stejný druh nastavení, který se nachází v atributech appSettings add, clear a remove a používá pro tyto prvky stejný formát dvojic klíč/hodnota.

Zadaná cesta je relativní k místnímu konfiguračnímu souboru. Pokud zadaný soubor nelze najít, běhové prostředí ignoruje atribut.

Jelikož některé změny v souboru Web.config mohou zapříčinit restart aplikace, lze použít samostatné soubory umožňující uživatelům upravit hodnoty v sekci appSettings bez vynucení restartování aplikace. Obsah samostatného souboru je sloučen s oddílem appSettings souboru Web.config. Tato funkce je omezena atributem appSettings.

POZNÁMKA V rozhraní .NET Framework verze 2.0 můžete vkládat nastavení konfigurace všech konfiguračních prvků, které podporují atribut configSource, do samostatného souboru. Nicméně, pokud použijete atribut configSource, je potřeba přesunout celý oddíl do samostatného souboru, jinak by žádná data nebyla sloučena. Zápis do souboru Web.config se provede jednorázově při použití atributu configSource. Toto sice způsobí restartování aplikace, ale následné aktualizace oddílu se zapisují přímo do samostatného soubor a nezpůsobí tak další restartování aplikace. Další informace naleznete v tématu ConfigSource.

Zděděné atributy

Volitelné atributy.

Atributy, které jsou děděny všemi prvky oddílu.

Podřízené prvky

Prvek	Popis
add	Volitelný prvek. Přidá vlastní nastavení aplikace do kolekce nastavení aplikace ve tvaru dvojice klíč/hodnota.
clear	Volitelný element. Odebere všechny odkazy na zděděná vlastní nastavení aplikace a povolí pouze odkazy přidané aktuálním atributem add.
remove	Volitelný element. Odebere odkaz na zděděné vlastní nastavení aplikace z kolekce vlastních nastavení aplikace.

add

Volitelný prvek.

Přidá vlastní nastavení aplikace do kolekce nastavení aplikace ve tvaru dvojice klíč/hodnota.

clear

Volitelný element.

Odebere všechny odkazy na zděděná vlastní nastavení aplikace a povolí pouze odkazy přidané aktuálním atributem add.

remove

Volitelný element.

Odebere odkaz na zděděné vlastní nastavení aplikace z kolekce vlastních nastavení aplikace.

Nadřazené prvky

Prvek	Popis
configuration	Určuje požadovaný kořenový element nacházející se v každém konfiguračním souboru, který je používán modulem CLR (Common Language Runtime) a aplikacemi rozhraní .NET Framework.
system.web	Určuje kořenový element konfiguračního souboru s nastavením konfigurace technologie ASP.NET a obsahuje konfigurační prvky, které konfigurují webové aplikace ASP.NET a řídí chování aplikací.

Poznámky

Element appSettings ukládá informace o vlastní konfiguraci aplikace, jako například cesty k souborům, adresy URL webových služeb XML nebo jakékoli jiné informace, které jsou uloženy v souboru INI dané aplikace. Dvojice klíče a hodnoty určené v appSettings prvku lze získat přístup pomocí kódu ConfigurationManager Třída Naleznete v příkladu kódu v třídě jak přístup appSettings programově.

Můžete použít atribut file pro označení konfiguračního souboru, který poskytuje dodatečná nastavení nebo přepíše nastavení zadaná v elementu appSettings. Ve scénářích správy zdrojového kódu týmového vývoje můžete použít atribut file. Například v případě, kdy chce uživatel přepsat nastavení projektu uvedené v konfiguračním soubor aplikace. Konfigurační soubory, které jsou určeny v atributu file, musí mít jako kořenový prvek spíše element appSettings než element configuration.

V aplikacích .NET Framework verze 2. 0 ukládejte připojovací řetězce k databází v kolekci Element connectionStrings (schéma nastavení ASP.NET) namísto kolekce s nastavením aplikace.

Výchozí konfigurace

Následující výchozí element appSettings není explicitně nakonfigurován v souboru Machine.config nebo v kořenovém souboru web.config. To je však výchozí konfigurace, kterou vrací aplikace.

   <appSettings file="">
      <settings>
         <clear />
      </settings>
   </appSettings>

Příklad

Konfigurační soubory, které jsou určeny v atributu file, musí mít jako kořenový prvek spíše element appSettings než element configuration.

Následující příklad kódu demonstruje správné použití konfiguračního souboru, který je určen v atributu file.

<?xml version="1.0" encoding="utf-8" ?>
<appSettings>
<add key="Application1" value="MyApplication1" />
<add key="Setting1" value="MySetting" />
</appSettings>

Následující příklad kódu ukazuje, jak definovat vlastní nastavení aplikace v konfiguračním souboru.

<configuration>
    <appSettings>
        <add key="Application Name" value="MyApplication" />
    </appSettings>
</configuration>

Informace prvku

Obslužná rutina konfiguračního oddílu	AppSettingsSection
Konfigurační člen	AppSettings AppSettings AppSettings
Konfigurovatelná umístění	Machine.config Web.config kořenové úrovně Web.config aplikační úrovně Soubor web.config na úrovni fyzického nebo virtuálního adresáře
Požadavky	Microsoft Internet Information Services (IIS) 5.0, 5.1 nebo 6.0 .NET Framework, verze 1.0, 1.1 nebo 2.0 Microsoft Visual Studio 2003 nebo Visual Studio 2005

Viz také