appSettings 元素(常规设置架构)
[本文档仅供预览,在以后的发行版中可能会发生更改。包含的空白主题用作占位符。]
包含自定义应用程序设置,如文件路径、XML Web services URL 或存储在应用程序的 .ini 文件中的任何信息。
<appSettings
file="relative file name" >
</appSettings>
特性和元素
以下几节描述了特性、子元素和父元素。
特性
元素 |
说明 |
---|---|
file |
可选的 String 特性。 指定包含自定义应用程序配置设置的外部文件的相对路径。 指定的文件包含的设置类型与在 appSettings add、clear 和 remove 特性中指定的设置类型相同,并且使用的键/值对格式也与这些元素相同。 指定的路径是本地配置文件的相对路径。 如果找不到指定的文件,运行时会忽略该特性。 由于 Web.config 文件的任何更改都会导致应用程序重新启动,因此,使用一个单独的文件则既可以让用户修改 appSettings 节中的值,又不会导致应用程序重新启动。 该单独文件的内容将与 Web.config 文件中的 appSettings 节合并。 此功能限于 appSettings 特性。 注意 在 .NET Framework 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 services URL 或存储在应用程序的 .ini 文件中的任何信息。 可以使用 ConfigurationManager 类在代码中访问 appSettings 元素中指定的键/值对。 有关如何以编程的方式访问 appSettings 的信息,请参考类中显示的代码示例。
您可以使用 file 特性指定一个配置文件,该配置文件提供其他设置或重写 appSettings 元素中指定的设置。 您可以将 file 特性用于源代码管理组开发方案,例如,当用户需要重写在应用程序配置文件中指定的项目设置时。 在 file 特性中指定的配置文件必须将 appSettings 元素(而不是 configuration 元素)作为根节点。
在 .NET Framework 2.0 版应用程序中,将数据库连接字符串存储在 connectionStrings 元素(ASP.NET 设置架构) 集合中,而不是存储在应用程序设置集合中。
默认配置
下面的默认 appSettings 元素不是在 Machine.config 文件或根 Web.config 文件中显式配置的。 而是由应用程序返回的默认配置。
<appSettings file="">
<settings>
<clear />
</settings>
</appSettings>
示例
在 file 特性中指定的配置文件必须将 appSettings 元素(而不是 configuration 元素)作为根节点。
下面的代码示例演示如何使用在 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 信息服务 (IIS) 5.0、5.1 或 6.0 .NET Framework 版本 1.0、1.1 或 2.0 Microsoft Visual Studio 2003 或 Visual Studio 2005 |
请参见
参考
appSettings 的 clear 元素(常规设置架构)
appSettings 的 remove 元素(常规设置架构)