Элемент appSettings (схема общих параметров)
Обновлен: Ноябрь 2007
Содержит пользовательские параметры приложения, такие как пути к файлам, URL-адреса веб-служб XML и другие сведения, хранящиеся в INI-файле для приложения.
Элемент configuration (схема общих параметров)
Элемент appSettings (схема общих параметров)
<appSettings
file="relative file name" >
</appSettings>
Атрибуты и элементы
В следующих разделах описаны атрибуты, дочерние и родительские элементы.
Атрибуты
Элемент |
Описание |
|---|---|
file |
Необязательный атрибут String. Указывает относительный путь к внешнему файлу, содержащему пользовательские параметры конфигурации приложения. Указанный файл содержит параметры того же вида, что и указанные в атрибутах appSettingsadd, clear и remove, и использует тот же формат пар ключ-значение, что и эти элементы. Путь является относительным и указан относительно локального файла конфигурации. Во время выполнения этот атрибут не обрабатывается, если указанный файл отсутствует. Поскольку любые изменения в файле Web.config приводят к перезапуску приложения, использование отдельного файла позволяет пользователям изменять значения в разделе appSettings без необходимости повторного запуска приложения. Содержимое отдельного файла объединяется с разделом appSettings в файле Web.config. Данная функциональная возможность ограничена атрибутом appSettings. Примечание. В среде .NET Framework версии 2.0 параметры конфигурации теперь можно включить в отдельный файл для всех элементов конфигурации, которые поддерживают атрибут configSource. Однако при использовании атрибута configSource необходимо переместить весь раздел в отдельный файл из-за отсутствия процессов слияния параметров элементов. Операция записи в файл Web.config выполняется один раз, когда используется атрибут configSource. После этой операции необходимо перезапустить приложение, однако последующие обновления в разделе записываются непосредственно в отдельный файл и не приводят к последующим повторным запускам приложения. Дополнительные сведения см. в разделе ConfigSource. |
Наследуемые атрибуты |
Необязательные атрибуты. Атрибуты, наследуемые всеми элементами раздела. |
Дочерние элементы
Элемент |
Описание |
|---|---|
add |
Необязательный элемент. Добавляет в коллекцию параметров приложения пользовательский параметр приложения в виде пары имя-значение. |
clear |
Необязательный элемент. Удаляет все ссылки на наследуемые пользовательские параметры приложения и оставляет только те ссылки, которые были добавлены текущим атрибутом add. |
remove |
Необязательный элемент. Удаляет ссылку на наследуемый пользовательский параметр приложения из коллекции параметров приложения. |
Родительские элементы
Элемент |
Описание |
|---|---|
configuration |
Указывает обязательный корневой элемент любого файла конфигурации, используемого средой CLR и приложениями .NET Framework. |
system.web |
Указывает корневой элемент для параметров конфигурации ASP.NET в файле конфигурации и содержит элементы конфигурации, предназначенные для настройки веб-приложений ASP.NET и управления их работой. |
Заметки
Элемент appSettings содержит пользовательские данные конфигурации, такие как пути файлов, URL-адреса веб-служб XML и другие сведения, хранящиеся в INI-файле для приложения. Доступ из кода к парам ключ-значение, заданным в элементе appSettings, можно получить с помощью класса ConfigurationSettings.
Атрибут 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 Information Services (IIS) версии 5.0, 5.1 или 6.0 .NET Framework версии 1.0, 1.1 или 2.0 Microsoft Visual Studio 2003 или Visual Studio 2005 |
См. также
Основные понятия
Настройка обеспечения безопасности ASP.NET
Ссылки
Элемент configuration (схема общих параметров)
Элемент add для элемента appSettings (схема общих параметров)
Элемент clear для элемента appSettings (схема общих параметров)
Элемент remove для элемента appSettings (схема общих параметров)
Другие ресурсы
Общие параметры конфигурации (ASP.NET)