Elemento section para configSections (Esquema de configuración general)

Artículo
08/10/2011

Define una asociación entre un controlador de sección de configuración y un elemento de configuración.

<section 
   name="section name"
   type="configuration section handler class, assembly file name, version, culture, public key token"
   allowDefinition= "Everywhere|MachineOnly|MachineToApplication|MachineToWebRoot" 
   allowLocation="True|False" 
   restartOnExternalChanges="True|False" 
/>

Atributos y elementos

En las secciones siguientes se describen los atributos, los elementos secundarios y los elementos primarios.

Atributos

Atributo	Descripción
allowDefinition	Atributo Enum opcional. Sólo se aplica a las aplicaciones ASP.NET. Especifica en qué archivo de configuración se puede utilizar la sección. Este atributo puede ser uno de los valores siguientes (se define en la enumeración ConfigurationAllowDefinition), por orden de ámbito descendente. ValorDescripción Everywhere Permite configurar la sección en cualquier archivo de configuración o directorio, de la manera que sigue: Machine.config Web.config raíz Web.config para una aplicación Directorio virtual Subdirectorio físico en la aplicación. Si no se utiliza ningún atributo allowDefinition, se supone que es Everywhere.Éste es el valor predeterminado. MachineToApplication Permite configurar la sección en uno de los archivos siguientes: Machine.config Web.config raíz Web.config para una aplicación. Se excluyen los archivos Web.config de directorios virtuales o de un subdirectorio físico de la aplicación. MachineToWebRoot Permite configurar la sección en uno de los archivos siguientes: Machine.config Web.config raíz. Los archivos Machine.config y Web.config raíz se encuentran en %SystemRoot%\Microsoft.NET\Framework\númeroDeVersión\CONFIG. MachineOnly Permite configurar la sección sólo en el archivo Machine.config, situado en %SystemRoot%\Microsoft.NET\Framework\númeroDeVersión\CONFIG.
allowExeDefinition	Atributo Enum opcional. Sólo se aplica a las aplicaciones cliente de .NET Framework. Especifica en qué archivo de configuración se puede utilizar la sección. Este atributo puede ser uno de los valores siguientes (se define en la enumeración ConfigurationAllowExeDefinition), por orden de ámbito descendente. ValorDescripción MachineToApplication Permite configurar la sección en uno de los archivos siguientes: Machine.config Configuración de la aplicación. MachineToRoamingUser MachineToLocalUser MachineOnly Permite configurar la sección sólo en el archivo Machine.config, situado en %SystemRoot%\Microsoft.NET\Framework\númeroDeVersión\CONFIG.
allowLocation	Atributo Boolean opcional. Sólo se aplica a las aplicaciones ASP.NET. Determina si la sección se puede utilizar en el elemento location. El valor predeterminado es True.
name	Atributo String requerido. Especifica el nombre de la sección o elemento de configuración asociado al controlador de sección de configuración que se especifica en el atributo type. Éste es el nombre del elemento que aparece en el área de configuración de sección del archivo de configuración.
restartOnExternalChanges	Atributo Boolean opcional. No se aplica a las aplicaciones ASP.NET. Especifica si la aplicación debe reiniciarse en caso de que cambien los datos de configuración de la sección.
type	Atributo String requerido. Especifica el nombre de la clase de controlador de sección de configuración que controla el procesamiento de los valores de configuración de la sección o del elemento que se especifica en el atributo name. Utilice el formato siguiente: type="Nombre de clase completo, nombre del archivo del ensamblado, versión, referencia cultural, token de clave pública" La definición debe coincidir con la referencia de ensamblado. Por ejemplo, si el número de versión del siguiente ejemplo de sintaxis no coincide con el del ensamblado, se produce un error. `type="MyConfigSectionHandler.MyHandler,MyCustomConfigurationHandler,Version=1.0.0.0,Culture=neutral,PublicKeyToken=null"` El archivo de ensamblado se debe encontrar en el mismo directorio de aplicación que el archivo Web.config que define el archivo de ensamblado. En el caso del archivo Web.config o Machine.config raíz, el archivo de ensamblado debe estar en el directorio %SystemRoot%\Microsoft.NET\Framework\versión.

Elementos secundarios

Ninguno.

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.
configSections	Especifica las declaraciones de las secciones de configuración y del espacio de nombres.
sectionGroup	Define una asociación entre un controlador de la sección de configuración y una sección de configuración.

Comentarios

Un elemento section asocia un controlador de la sección de configuración a un elemento de configuración o sección. Es necesario porque ASP.NET no hace ninguna suposición sobre cómo controlar los valores incluidos en un archivo de configuración. En lugar de ello, ASP.NET delega el procesamiento de los datos de configuración en los controladores de sección de configuración. Cada elemento section identifica una sección o elemento de configuración y la clase asociada que se deriva de ConfigurationSection que controla la sección o el elemento de configuración. Los elementos section se pueden agrupar lógicamente en elementos sectionGroup para organizarlos y para ayudar a evitar conflictos de nomenclatura. Los elementos section y sectionGroup se incluyen en el elemento configSections.

Configuración predeterminada

Las secciones de configuración de los elementos de configuración de .NET Framework se definen en el archivo Machine.config. Debido a que son muy numerosas, no se pueden incluir en este documento. En el siguiente extracto del archivo Machine.config se define el controlador de sección de configuración del elemento authentication de la sección system.web. A continuación, se definen las opciones de configuración para el elemento authentication.

Si un controlador de sección de configuración no está asociado con un elemento de configuración, ASP.NET emite el error de servidor "Sección de configuración nombre_elemento no reconocida".

<configuration>
    <configSections>
        <sectionGroup name="system.web" type="System.Web.Configuration.SystemWebSectionGroup, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%">
            <section name="authentication" type="System.Web.Configuration.AuthenticationSection, System.Web, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" allowDefinition="MachineToApplication" />
            <!-- Other system.web sections -->
        </sectionGroup>
        <!-- Other configuration sections -->
    </configSections>

    <system.web>
        <authentication mode="Windows">
            <forms name=".ASPXAUTH" 
                   loginUrl="login.aspx" defaultUrl="default.aspx" 
                   protection="All" 
                   timeout="30" 
                   path="/" 
                   requireSSL="False" 
                   slidingExpiration="True" 
                   cookieless="UseCookies" 
                   domain="" 
                   enableCrossAppRedirects="False">
                <credentials passwordFormat="SHA1" />
            </forms>
            <passport redirectUrl="internal" />
        </authentication>
        <!-- Other system.web elements -->
    </system.web>
    <!-- Other configuration settings -->
</configuration>

Ejemplo

En el siguiente ejemplo de código se muestra cómo definir una sección de configuración personalizada y los valores de configuración de esa sección.

<configuration>

   <configSections>
      <section name="sampleSection"
               type="System.Configuration.SingleTagSectionHandler" />
   </configSections>

   <sampleSection setting1="Value1" 
                  setting2="value two" 
                  setting3="third value" />

</configuration>

Información de elemento

Controlador de la sección de configuración	No procede.
Miembro de configuración	ConfigurationSection
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

Compartir a través de