Elemento appSettings (Esquema de configuración general)
[Esta documentación se proporciona solo para fines preliminares y está sujeta a cambios en versiones posteriores. Se incluye temas en blanco como marcadores].
Contiene configuración de la aplicación personalizada, como rutas de acceso a archivos, direcciones URL de servicios Web XML o cualquier información almacenada en el archivo .ini de una aplicación.
<appSettings
file="relative file name" >
</appSettings>
Atributos y elementos
En las próximas secciones se describen los atributos, los elementos secundarios y los elementos primarios.
Atributos
Elemento |
Descripción |
|---|---|
file |
Atributo String opcional. Especifica una ruta de acceso relativa a un archivo externo que contiene valores de configuración personalizados de la aplicación. El archivo especificado contiene el mismo tipo de configuración que se especifica en los atributos add, clear y remove de appSettings y utiliza el mismo formato de pares de clave y valor que dichos elementos. La ruta de acceso que se especifica es relativa al archivo de configuración local. El motor en tiempo de ejecución omitirá el atributo si no se encuentra el archivo especificado. Dado que, si se realizan cambios en el archivo Web.config, la aplicación se reinicia, al utilizar un archivo independiente, los usuarios pueden modificar los valores de la sección appSettings sin que esto suceda. El contenido del archivo independiente se combina con la sección appSettings del archivo Web.config. Esta funcionalidad se limita al atributo appSettings. Nota Ahora, en .NET Framework 2.0, se pueden incluir valores de configuración en un archivo independiente para todos los elementos de configuración que admiten el atributo configSource. Sin embargo, cuando se utiliza el atributo configSource, es necesario mover la sección completa al archivo independiente, porque no se realiza la combinación de la configuración del elemento. Al utilizar el atributo configSource, se realiza una única operación de escritura en el archivo Web.config. Esto hace que la aplicación se reinicie, pero las actualizaciones posteriores de la sección se escriben directamente en el archivo independiente y la aplicación no se reinicia más veces. Para obtener más información, vea ConfigSource. |
Atributos heredados |
Atributos opcionales. Atributos heredados por todos los elementos de una sección. |
Elementos secundarios
Elemento |
Descripción |
|---|---|
add |
Elemento opcional. Agrega a la colección de configuración de la aplicación un valor personalizado en forma de par de nombre y valor. |
clear |
Elemento opcional. Quita todas las referencias a la configuración de la aplicación personalizada heredada y sólo permite las referencias agregadas por el atributo add actual. |
remove |
Elemento opcional. Quita de la colección de configuración de la aplicación una referencia a una configuración de la aplicación personalizada heredada. |
Elementos primarios
Elemento |
Descripción |
|---|---|
configuration |
Especifica el elemento raíz necesario de cada archivo de configuración que utilizan las aplicaciones basadas en Common Language Runtime y .NET Framework. |
system.web |
Especifica el elemento raíz de los valores de configuración de ASP.NET en un archivo de configuración y contiene elementos de configuración que configuran aplicaciones Web ASP.NET y controlan el comportamiento de las aplicaciones. |
Comentarios
El elemento appSettings almacena información de configuración de aplicación personalizada, como rutas de acceso a archivos, direcciones URL de servicios Web XML o cualquier otra información almacenada en el archivo .ini de una aplicación. Se puede tener acceso a los pares de clave y valor especificados en el elemento appSettings en el código utilizando la clase ConfigurationManager. Consulte el ejemplo de código que se muestra en la clase para ver cómo obtener acceso a appSettings mediante programación.
El atributo file se puede utilizar para especificar un archivo de configuración que proporcione valores adicionales o reemplace los valores especificados en el elemento appSettings. El atributo file también se puede utilizar en situaciones de desarrollo en equipo de controles de código fuente, como en los casos en que un usuario desea reemplazar los valores de proyecto especificados en el archivo de configuración de una aplicación. Los archivos de configuración especificados en un atributo file deben tener como nodo raíz el elemento appSettings en lugar del elemento configuration.
En las aplicaciones de la versión 2.0 de .NET Framework, las cadenas de conexión a bases de datos se deben almacenar en la colección Elemento connectionStrings (Esquema de configuración de ASP.NET), no en la colección de configuración de la aplicación.
Configuración predeterminada
El siguiente elemento appSettings predeterminado no se configura explícitamente en el archivo Machine.config o en el archivo Web.config raíz. Sin embargo, es la configuración predeterminada que devuelve la aplicación.
<appSettings file="">
<settings>
<clear />
</settings>
</appSettings>
Ejemplo
Los archivos de configuración especificados en un atributo file deben tener como nodo raíz el elemento appSettings en lugar del elemento configuration.
En el ejemplo de código siguiente se muestra cómo utilizar la forma correcta para un archivo de configuración que se especifica en el atributo file.
<?xml version="1.0" encoding="utf-8" ?>
<appSettings>
<add key="Application1" value="MyApplication1" />
<add key="Setting1" value="MySetting" />
</appSettings>
En el siguiente ejemplo de código se muestra cómo definir una configuración de aplicación personalizada en un archivo de configuración.
<configuration>
<appSettings>
<add key="Application Name" value="MyApplication" />
</appSettings>
</configuration>
Información de elemento
Controlador de la sección de configuración |
|
Miembro de configuración |
|
Ubicaciones configurables |
Machine.config Web.config del nivel raíz Web.config del nivel de aplicaciones Web.config del nivel de directorio virtual o físico |
Requisitos |
Microsoft Internet Information Services (IIS) 5.0, 5.1 ó 6.0 .NET Framework 1.0, 1.1 ó 2.0 Microsoft Visual Studio 2003 o Visual Studio 2005 |
Vea también
Referencia
Elemento configuration (Esquema de configuración general)
Elemento add para appSettings (Esquema de configuración general)
Elemento clear para appSettings (Esquema de configuración general)
Elemento remove para appSettings (Esquema de configuración general)
Conceptos
Otros recursos
Opciones de configuración generales (ASP.NET)