appSettings 要素 (全般設定スキーマ)
ファイル パス、XML Web サービスの URL、アプリケーションの .ini ファイルに保存されている任意の情報など、カスタム アプリケーション設定を格納します。
<appSettings
file="relative file name" >
</appSettings>
属性および要素
以降のセクションでは、属性、子要素、および親要素について説明します。
属性
要素 |
説明 |
|---|---|
file |
省略可能な String 型の属性です。 カスタム アプリケーションの構成設定を含む外部ファイルへの相対パスを指定します。 指定されたファイルには、appSettings add、clear、および remove の各属性で指定されたものと同じ種類の設定が含まれ、これらの要素と同じキーと値のペア形式を使用します。 指定するパスは、ローカル構成ファイルへの相対パスです。 指定されたファイルが見つからない場合、ランタイムはこの属性を無視します。 Web.config ファイルが少しでも変更されるとアプリケーションが再起動されますが、別ファイルを使用することで、アプリケーションの再起動を発生させることなく appSettings セクションの値を変更できます。 別ファイルの内容は、Web.config ファイルの appSettings セクションとマージされます。 この機能は、appSettings 属性についてのみ使用できます。 メモ .NET Framework Version 2.0 から、configSource 属性をサポートするすべての構成要素について別ファイルの構成設定を含めることができます。 ただし、configSource 属性を使用する場合、要素設定はマージできないので、セクション全体を別ファイルに移動する必要があります。 configSource 属性を使用する場合、Web.config ファイルに一度だけ書き込みが発生します。 これによりアプリケーションが再起動されますが、それ以降、そのセクションの更新は別ファイルに直接書き込まれ、アプリケーションの再起動は発生しません。 詳細については、「ConfigSource」を参照してください。 |
継承される属性 |
省略可能な属性です。 すべてのセクション要素が継承する属性です。 |
子要素
要素 |
説明 |
|---|---|
add |
省略可能な要素です。 カスタム アプリケーション設定を、名前と値のペアとしてアプリケーション設定のコレクションに追加します。 |
clear |
省略可能な要素です。 継承したカスタム アプリケーション設定へのすべての参照を削除し、現在の add 属性によって追加された参照だけを許可します。 |
remove |
省略可能な要素です。 継承したカスタム アプリケーション設定への参照をアプリケーション設定のコレクションから削除します。 |
親要素
要素 |
説明 |
|---|---|
configuration |
共通言語ランタイムおよび .NET Framework アプリケーションで使用されるすべての構成ファイルで必要なルート要素を指定します。 |
system.web |
構成ファイルの ASP.NET 構成設定のルート要素を指定します。ASP.NET Web アプリケーションを構成する構成要素やアプリケーションの動作を制御する構成要素が含まれます。 |
解説
appSettings 要素には、ファイル パス、XML Web サービスの URL、アプリケーションの .ini ファイルに保存されている任意の情報など、カスタム アプリケーションの構成情報が格納されます。 appSettings 要素で指定されたキーと値のペアには、コードで ConfigurationManager クラスを使用してアクセスできます。 appSettings にプログラムによってアクセスする方法については、クラスで示されているコード例を参照してください。
追加設定が含まれる構成ファイル、または appSettings 要素で指定した設定をオーバーライドする構成ファイルを指定するには、file 属性を使用します。 file 属性は、アプリケーション構成ファイルで指定したプロジェクト設定をオーバーライドする場合など、ソース管理チームの開発シナリオでも使用できます。 file 属性で指定した構成ファイルには、ルート ノードとして、configuration 要素ではなく、appSettings 要素が含まれている必要があります。
.NET Framework Version 2.0 アプリケーションでは、データベース接続文字列を、アプリケーション設定コレクションにではなく、connectionStrings 要素 (ASP.NET 設定スキーマ) コレクションに格納します。
既定の構成
次の既定の appSettings 要素は、Machine.config ファイルまたはルート Web.config ファイルで明示的には構成されていません。 ただし、これはアプリケーションが返す既定の構成です。
<appSettings file="">
<settings>
<clear />
</settings>
</appSettings>
使用例
file 属性で指定した構成ファイルには、ルート ノードとして、configuration 要素ではなく、appSettings 要素が含まれている必要があります。
file 属性に指定されている構成ファイルの修正フォームを使用する方法を次のコード例に示します。
<?xml version="1.0" encoding="utf-8" ?>
<appSettings>
<add key="Application1" value="MyApplication1" />
<add key="Setting1" value="MySetting" />
</appSettings>
構成ファイルでカスタム アプリケーション設定を定義する方法を次のコード例に示します。
<configuration>
<appSettings>
<add key="Application Name" value="MyApplication" />
</appSettings>
</configuration>
要素情報
構成セクション ハンドラー |
|
構成メンバー |
|
構成できる場所 |
Machine.config ルート レベルの Web.config アプリケーション レベルの Web.config 仮想ディレクトリ レベルまたは物理ディレクトリ レベルの Web.config |
要件 |
Microsoft Internet Information Services (IIS) 5.0、5.1、または 6.0 .NET Framework Version 1.0、1.1、または 2.0 Microsoft Visual Studio 2003 または Visual Studio 2005 |
参照
参照
appSettings の add 要素 (全般設定スキーマ)
appSettings の clear 要素 (全般設定スキーマ)
appSettings の remove 要素 (全般設定スキーマ)