RoleManagerSection Classe

Définition

Espace de noms:

System.Web.Configuration

Assembly:

System.Web.dll

Définit des paramètres de configuration qui sont utilisés pour prendre en charge l'infrastructure de gestion de rôle d'applications Web. Cette classe ne peut pas être héritée.

public ref class RoleManagerSection sealed : System::Configuration::ConfigurationSection

public sealed class RoleManagerSection : System.Configuration.ConfigurationSection

type RoleManagerSection = class
    inherit ConfigurationSection

Public NotInheritable Class RoleManagerSection
Inherits ConfigurationSection

Héritage

Object

ConfigurationElement

ConfigurationSection

RoleManagerSection

Exemples

Cette section fournit deux exemples de code. Le premier montre comment spécifier de manière déclarative des valeurs pour plusieurs propriétés de la RoleManagerSection classe. La deuxième montre comment utiliser le RoleManagerSection type .

L’exemple de fichier de configuration suivant montre comment spécifier de manière déclarative des valeurs pour plusieurs propriétés de la RoleManagerSection classe.

<system.web>  
  <roleManager   
    enabled="false"   
    cacheRolesInCookie="false"   
    cookieName=".ASPXROLES" cookieTimeout="30"  
    cookiePath="/" cookieRequireSSL="false"  
    cookieSlidingExpiration="true" createPersistentCookie="false"  
    cookieProtection="All"   
    defaultProvider="AspNetSqlRoleProvider"  
    maxCachedResults="25"  >  
    <providers>  
      <add   
        name="AspNetSqlRoleProvider"  
        connectionStringName="LocalSqlServer"   
        applicationName="/"  
        type="System.Web.Security.SqlRoleProvider, System.Web,  
          Version=2.0.3600.0, Culture=neutral,  
          PublicKeyToken=b03f5f7f11d50a3a" />  
      <add   
        name="AspNetWindowsTokenRoleProvider"   
        applicationName="/"  
        type="System.Web.Security.WindowsTokenRoleProvider, System.Web,   
          Version=2.0.3600.0, Culture=neutral,   
          PublicKeyToken=b03f5f7f11d50a3a" />  
    </providers>  
  </roleManager>  
</system.web>  

L’exemple de code suivant montre comment utiliser le RoleManagerSection type .

#region Using directives

using System;
using System.Collections.Generic;
using System.Text;
using System.Configuration;
using System.Web;
using System.Web.Configuration;

#endregion

namespace Samples.Aspnet.SystemWebConfiguration
{
  class UsingRoleManagerSection
  {
    static void Main(string[] args)
    {
      try
      {
        // Set the path of the config file.
        string configPath = "";

        // Get the Web application configuration object.
        Configuration config = WebConfigurationManager.OpenWebConfiguration(configPath);

        // Get the section related object.
        RoleManagerSection configSection =
          (RoleManagerSection)config.GetSection("system.web/roleManager");

        // Display title and info.
        Console.WriteLine("ASP.NET Configuration Info");
        Console.WriteLine();

        // Display Config details.
        Console.WriteLine("File Path: {0}",
          config.FilePath);
        Console.WriteLine("Section Path: {0}",
          configSection.SectionInformation.Name);

        // Display CacheRolesInCookie property.
        Console.WriteLine("CacheRolesInCookie: {0}",
          configSection.CacheRolesInCookie);

        // Set CacheRolesInCookie property.
        configSection.CacheRolesInCookie = false;

        // Display CookieName property.
        Console.WriteLine("CookieName: {0}", configSection.CookieName);

        // Set CookieName property.
        configSection.CookieName = ".ASPXROLES";

        // Display CookiePath property.
        Console.WriteLine("CookiePath: {0}", configSection.CookiePath);

        // Set CookiePath property.
        configSection.CookiePath = "/";

        // Display CookieProtection property.
        Console.WriteLine("CookieProtection: {0}",
          configSection.CookieProtection);

        // Set CookieProtection property.
        configSection.CookieProtection =
          System.Web.Security.CookieProtection.All;

        // Display CookieRequireSSL property.
        Console.WriteLine("CookieRequireSSL: {0}",
          configSection.CookieRequireSSL);

        // Set CookieRequireSSL property.
        configSection.CookieRequireSSL = false;

        // Display CookieSlidingExpiration property.
        Console.WriteLine("CookieSlidingExpiration: {0}",
          configSection.CookieSlidingExpiration);

        // Set CookieSlidingExpiration property.
        configSection.CookieSlidingExpiration = true;

        // Display CookieTimeout property.
        Console.WriteLine("CookieTimeout: {0}", configSection.CookieTimeout);

        // Set CookieTimeout property.
        configSection.CookieTimeout = TimeSpan.FromMinutes(30);

        // Display CreatePersistentCookie property.
        Console.WriteLine("CreatePersistentCookie: {0}",
          configSection.CreatePersistentCookie);

        // Set CreatePersistentCookie property.
        configSection.CreatePersistentCookie = false;

        // Display DefaultProvider property.
        Console.WriteLine("DefaultProvider: {0}",
          configSection.DefaultProvider);

        // Set DefaultProvider property.
        configSection.DefaultProvider = "AspNetSqlRoleProvider";

        // Display Domain property.
        Console.WriteLine("Domain: {0}", configSection.Domain);

        // Set Domain property.
        configSection.Domain = "";

        // Display Enabled property.
        Console.WriteLine("Enabled: {0}", configSection.Enabled);

        // Set Enabled property.
        configSection.Enabled = false;

        // Display the number of Providers
        Console.WriteLine("Providers Collection Count: {0}",
          configSection.Providers.Count);

        // Display elements of the Providers collection property.
        foreach (ProviderSettings providerItem in configSection.Providers)
        {
          Console.WriteLine();
          Console.WriteLine("Provider Details:");
          Console.WriteLine("Name: {0}", providerItem.Name);
          Console.WriteLine("Type: {0}", providerItem.Type);
        }

        // Update if not locked.
        if (!configSection.SectionInformation.IsLocked)
        {
          config.Save();
          Console.WriteLine("** Configuration updated.");
        }
        else
        {
          Console.WriteLine("** Could not update, section is locked.");
        }
      }

      catch (Exception e)
      {
        // Unknown error.
        Console.WriteLine(e.ToString());
      }

      // Display and wait
      Console.ReadLine();
    }
  }
}

Imports System.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Web
Imports System.Web.Configuration

Namespace Samples.Aspnet.SystemWebConfiguration
  Class UsingRoleManagerSection
    Public Shared Sub Main()
      Try
        ' Set the path of the config file.
        Dim configPath As String = ""

        ' Get the Web application configuration object.
        Dim config As System.Configuration.Configuration = _
         System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(configPath)

        ' Get the section related object.
        Dim configSection As System.Web.Configuration.RoleManagerSection = _
         CType(config.GetSection("system.web/roleManager"), _
         System.Web.Configuration.RoleManagerSection)

        ' Display title and info.
        Console.WriteLine("ASP.NET Configuration Info")
        Console.WriteLine()

        ' Display Config details.
        Console.WriteLine("File Path: {0}", config.FilePath)
        Console.WriteLine("Section Path: {0}", configSection.SectionInformation.Name)

        ' Display CacheRolesInCookie property.
        Console.WriteLine("CacheRolesInCookie: {0}", _
         configSection.CacheRolesInCookie)

        ' Set CacheRolesInCookie property.
        configSection.CacheRolesInCookie = False

        ' Display CookieName property.
        Console.WriteLine("CookieName: {0}", configSection.CookieName)

        ' Set CookieName property.
        configSection.CookieName = ".ASPXROLES"

        ' Display CookiePath property.
        Console.WriteLine("CookiePath: {0}", configSection.CookiePath)

        ' Set CookiePath property.
        configSection.CookiePath = "/"

        ' Display CookieProtection property.
        Console.WriteLine("CookieProtection: {0}", _
         configSection.CookieProtection)

        ' Set CookieProtection property.
        configSection.CookieProtection = _
         System.Web.Security.CookieProtection.All

        ' Display CookieRequireSSL property.
        Console.WriteLine("CookieRequireSSL: {0}", _
         configSection.CookieRequireSSL)

        ' Set CookieRequireSSL property.
        configSection.CookieRequireSSL = False

        ' Display CookieSlidingExpiration property.
        Console.WriteLine("CookieSlidingExpiration: {0}", _
         configSection.CookieSlidingExpiration)

        ' Set CookieSlidingExpiration property.
        configSection.CookieSlidingExpiration = True

        ' Display CookieTimeout property.
        Console.WriteLine("CookieTimeout: {0}", configSection.CookieTimeout)

        ' Set CookieTimeout property.
        configSection.CookieTimeout = TimeSpan.FromMinutes(30)

        ' Display CreatePersistentCookie property.
        Console.WriteLine("CreatePersistentCookie: {0}", _
         configSection.CreatePersistentCookie)

        ' Set CreatePersistentCookie property.
        configSection.CreatePersistentCookie = False

        ' Display DefaultProvider property.
        Console.WriteLine("DefaultProvider: {0}", _
         configSection.DefaultProvider)

        ' Set DefaultProvider property.
        configSection.DefaultProvider = "AspNetSqlRoleProvider"

        ' Display Domain property.
        Console.WriteLine("Domain: {0}", configSection.Domain)

        ' Set Domain property.
        configSection.Domain = ""

        ' Display Enabled property.
        Console.WriteLine("Enabled: {0}", configSection.Enabled)

        ' Set CookieName property.
        configSection.Enabled = False

        ' Display the number of Providers
        Console.WriteLine("Providers Collection Count: {0}", _
         configSection.Providers.Count)

        ' Display elements of the Providers collection property.
        For Each providerItem As ProviderSettings In configSection.Providers()
          Console.WriteLine()
          Console.WriteLine("Provider Details:")
          Console.WriteLine("Name: {0}", providerItem.Name)
          Console.WriteLine("Type: {0}", providerItem.Type)
        Next

        ' Update if not locked.
        If Not configSection.SectionInformation.IsLocked Then
          config.Save()
          Console.WriteLine("** Configuration updated.")
        Else
          Console.WriteLine("** Could not update, section is locked.")
        End If

      Catch e As Exception
        ' Unknown error.
        Console.WriteLine(e.ToString())
      End Try

      ' Display and wait
      Console.ReadLine()
    End Sub
  End Class
End Namespace

Remarques

La RoleManagerSection classe permet d’accéder et de modifier par programmation le contenu de la roleManager section du fichier de configuration.

Constructeurs

RoleManagerSection()

Initialise une nouvelle instance de la classe RoleManagerSection en utilisant les paramètres par défaut.

Propriétés

CacheRolesInCookie	Obtient ou définit une valeur indiquant si les rôles de l'utilisateur en cours sont cachés dans un cookie.
CookieName	Obtient ou définit le nom du cookie qui est utilisé pour mettre en cache des noms de rôles.
CookiePath	Obtient ou définit le chemin d'accès virtuel du cookie qui est utilisé pour mettre en cache des noms de rôles.
CookieProtection	Obtient ou définit le type de sécurité qui est utilisée pour protéger le cookie qui met en cache des noms de rôles.
CookieRequireSSL	Obtient ou définit une valeur indiquant si le cookie qui est utilisé pour mettre en cache des noms de rôles requiert une connexion via le protocole SSL (Secure Sockets Layer) pour être retourné au serveur.
CookieSlidingExpiration	Obtient ou définit une valeur indiquant si le cookie qui est utilisé pour mettre en cache des noms de rôles sera périodiquement réinitialisé.
CookieTimeout	Obtient ou définit le nombre de minutes avant l'expiration du cookie utilisé pour mettre en cache des noms de rôles.
CreatePersistentCookie	Indique si un cookie basé sur session ou un cookie persistant est utilisé pour mettre en cache des noms de rôles.
CurrentConfiguration	Obtient une référence à l'instance Configuration de niveau supérieur qui représente la hiérarchie de configuration à laquelle l'instance ConfigurationElement actuelle appartient. (Hérité de ConfigurationElement)
DefaultProvider	Obtient ou définit le nom du fournisseur par défaut utilisé pour gérer des rôles.
Domain	Obtient ou définit le nom du domaine associé au cookie utilisé pour mettre en cache des noms de rôles.
ElementInformation	Obtient un objet ElementInformation qui contient les fonctionnalités et informations non personnalisables de l'objet ConfigurationElement. (Hérité de ConfigurationElement)
ElementProperty	Obtient l'objet ConfigurationElementProperty qui représente l'objet ConfigurationElement lui-même. (Hérité de ConfigurationElement)
Enabled	Obtient ou définit une valeur indiquant si la fonction de gestion du rôle ASP.NET est activée.
EvaluationContext	Obtient l'objet ContextInformation pour l'objet ConfigurationElement. (Hérité de ConfigurationElement)
HasContext	Obtient une valeur qui indique si la propriété CurrentConfiguration a la valeur null. (Hérité de ConfigurationElement)
Item[ConfigurationProperty]	Obtient ou définit une propriété ou un attribut de cet élément de configuration. (Hérité de ConfigurationElement)
Item[String]	Obtient ou définit une propriété, un attribut ou un élément enfant de cet élément de configuration. (Hérité de ConfigurationElement)
LockAllAttributesExcept	Obtient la collection d'attributs verrouillés. (Hérité de ConfigurationElement)
LockAllElementsExcept	Obtient la collection d'éléments verrouillés. (Hérité de ConfigurationElement)
LockAttributes	Obtient la collection d'attributs verrouillés. (Hérité de ConfigurationElement)
LockElements	Obtient la collection d'éléments verrouillés. (Hérité de ConfigurationElement)
LockItem	Obtient ou définit une valeur indiquant si l'élément est verrouillé. (Hérité de ConfigurationElement)
MaxCachedResults	Obtient ou définit le nombre maximal de rôles qu'ASP.NET met en cache dans le cookie de rôle.
Properties	Obtient la collection de propriétés. (Hérité de ConfigurationElement)
Providers	Obtient un objet ProviderSettingsCollection d'éléments ProviderSettings.
SectionInformation	Obtient un objet SectionInformation qui contient les fonctionnalités et informations non personnalisables de l'objet ConfigurationSection. (Hérité de ConfigurationSection)

Méthodes

DeserializeElement(XmlReader, Boolean)	Lit du XML à partir du fichier de configuration. (Hérité de ConfigurationElement)
DeserializeSection(XmlReader)	Lit du XML à partir du fichier de configuration. (Hérité de ConfigurationSection)
Equals(Object)	Compare l’instance de ConfigurationElement actuelle à l’objet spécifié. (Hérité de ConfigurationElement)
GetHashCode()	Obtient une valeur unique représentant l'instance actuelle de ConfigurationElement. (Hérité de ConfigurationElement)
GetRuntimeObject()	Retourne un objet personnalisé en cas de substitution dans une classe dérivée. (Hérité de ConfigurationSection)
GetTransformedAssemblyString(String)	Retourne la version transformée du nom de l'assembly spécifié. (Hérité de ConfigurationElement)
GetTransformedTypeString(String)	Retourne la version transformée du nom de type spécifié. (Hérité de ConfigurationElement)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
Init()	Rétablit l’état initial de l’objet ConfigurationElement. (Hérité de ConfigurationElement)
InitializeDefault()	Utilisé pour initialiser un jeu de valeurs par défaut pour l'objet ConfigurationElement. (Hérité de ConfigurationElement)
IsModified()	Indique si cet élément de configuration a été modifié depuis son dernier enregistrement ou chargement lorsqu'il est implémenté dans une classe dérivée. (Hérité de ConfigurationSection)
IsReadOnly()	Obtient une valeur indiquant si l’objet ConfigurationElement est en lecture seule. (Hérité de ConfigurationElement)
ListErrors(IList)	Ajoute les erreurs de propriété non valide dans cet objet ConfigurationElement et dans tous les sous-éléments à la liste passée. (Hérité de ConfigurationElement)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
OnDeserializeUnrecognizedAttribute(String, String)	Obtient une valeur indiquant si un attribut inconnu est rencontré pendant la désérialisation. (Hérité de ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Obtient une valeur indiquant si un élément inconnu est rencontré pendant la désérialisation. (Hérité de ConfigurationElement)
OnRequiredPropertyNotFound(String)	Lève une exception lorsqu'une propriété requise est introuvable. (Hérité de ConfigurationElement)
PostDeserialize()	Appelé après la désérialisation. (Hérité de ConfigurationElement)
PreSerialize(XmlWriter)	Appelé avant la sérialisation. (Hérité de ConfigurationElement)
Reset(ConfigurationElement)	Rétablit l'état interne de l'objet ConfigurationElement, y compris les verrouillages et les collections de propriétés. (Hérité de ConfigurationElement)
ResetModified()	Réinitialise la valeur de la méthode IsModified() à false en cas d’implémentation dans une classe dérivée. (Hérité de ConfigurationSection)
SerializeElement(XmlWriter, Boolean)	Écrit le contenu de cet élément de configuration dans le fichier de configuration lorsqu'il est implémenté dans une classe dérivée. (Hérité de ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)	Crée une chaîne XML contenant un affichage non fusionné de l'objet ConfigurationSection sous la forme d'une section unique à écrire dans un fichier. (Hérité de ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)	Écrit les balises extérieures de cet élément de configuration dans le fichier de configuration lorsqu'il est implémenté dans une classe dérivée. (Hérité de ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Affecte la valeur spécifiée à une propriété. (Hérité de ConfigurationElement)
SetReadOnly()	Définit la propriété IsReadOnly() pour l'objet ConfigurationElement et tous les sous-éléments. (Hérité de ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)	Indique si l’élément spécifié doit être sérialisé lorsque la hiérarchie des objets de configuration est sérialisée pour la version cible spécifiée du .NET Framework. (Hérité de ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)	Indique si la propriété spécifiée doit être sérialisée lorsque la hiérarchie des objets de configuration est sérialisée pour la version cible spécifiée du .NET Framework. (Hérité de ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName)	Indique si l’instance actuelle ConfigurationSection doit être sérialisée lorsque la hiérarchie des objets de configuration est sérialisée pour la version cible spécifiée du .NET Framework. (Hérité de ConfigurationSection)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Modifie l'objet ConfigurationElement pour supprimer toutes les valeurs qui ne doivent pas être enregistrées. (Hérité de ConfigurationElement)

Voir aussi

• ConfigurationSection
• RoleManagerModule
• Roles
• Présentation de la gestion des rôles