RoleManagerSection 類別

參考

定義

命名空間:: System.Web.Configuration

組件:: System.Web.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

定義用於支援 Web 應用程式角色管理基礎結構的組態設定。此類別無法獲得繼承。

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

繼承: Object

ConfigurationElement

ConfigurationSection
RoleManagerSection

範例

本節提供兩個程式代碼範例。第一個示範如何以宣告方式指定類別數個 RoleManagerSection 屬性的值。第二個示範如何使用 RoleManagerSection 類型。

下列組態檔範例示範如何以宣告方式指定類別數個 RoleManagerSection 屬性的值。

<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>

下列程式代碼範例示範如何使用 RoleManagerSection 類型。

#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

備註

類別 RoleManagerSection 提供一種方式，以程式設計方式存取和修改組態檔區 roleManager 段的內容。

建構函式

RoleManagerSection()

使用預設值初始化 RoleManagerSection 類別的新執行個體。

屬性

CacheRolesInCookie	取得或設定數值，表示目前使用者的角色是否應存放在 Cookie 快取中。
CookieName	取得或設定用於快取存放角色名稱的 Cookie 名稱。
CookiePath	取得或設定用於快取存放角色名稱的 Cookie 虛擬路徑。
CookieProtection	取得或設定安全類型，用於保護快取存放角色名稱的 Cookie。
CookieRequireSSL	取得或設定數值，表示快取存放角色名稱的 Cookie 是否需要 Secure Socket Layer (SSL) 連線才能傳回伺服器。
CookieSlidingExpiration	取得或設定數值，表示快取存放角色名稱的 Cookie 是否會定期重設。
CookieTimeout	取得或設定用於快取存放角色名稱的 Cookie 還有多少分鐘之後就算到期。
CreatePersistentCookie	代表要用工作階段 Cookie 或永續性 Cookie 快取存放角色名稱。
CurrentConfiguration	取得最上層 Configuration 執行個體的參考，這個執行個體表示目前 ConfigurationElement 執行個體所屬的組態階層架構。 (繼承來源 ConfigurationElement)
DefaultProvider	取得或設定用來管理角色的預設提供者名稱。
Domain	取得或設定用於快取存放角色名稱的 Cookie 其關聯的網域名稱。
ElementInformation	取得 ElementInformation 物件，其中包含 ConfigurationElement 物件之不可自訂的資訊和功能。 (繼承來源 ConfigurationElement)
ElementProperty	取得表示 ConfigurationElementProperty 物件本身的 ConfigurationElement 物件。 (繼承來源 ConfigurationElement)
Enabled	取得或設定數值，表示 ASP.NET 角色管理功能是否啟用。
EvaluationContext	取得 ConfigurationElement 物件的 ContextInformation 物件。 (繼承來源 ConfigurationElement)
HasContext	取得值，指出 CurrentConfiguration 屬性是否為 `null`。 (繼承來源 ConfigurationElement)
Item[ConfigurationProperty]	取得或設定此組態項目的屬性 (Property) 或屬性 (Attribute)。 (繼承來源 ConfigurationElement)
Item[String]	取得或設定此一組態項目的屬性或子項目。 (繼承來源 ConfigurationElement)
LockAllAttributesExcept	取得已鎖定屬性的集合。 (繼承來源 ConfigurationElement)
LockAllElementsExcept	取得已鎖定項目的集合。 (繼承來源 ConfigurationElement)
LockAttributes	取得已鎖定屬性的集合。 (繼承來源 ConfigurationElement)
LockElements	取得已鎖定項目的集合。 (繼承來源 ConfigurationElement)
LockItem	取得或設定值，指出此項目是否已被鎖定。 (繼承來源 ConfigurationElement)
MaxCachedResults	取得或設定 ASP.NET 在角色 Cookie 中快取存放的角色數量上限。
Properties	取得屬性的集合。 (繼承來源 ConfigurationElement)
Providers	取得 ProviderSettingsCollection 項目的 ProviderSettings 物件。
SectionInformation	取得 SectionInformation 物件，該物件包含 ConfigurationSection 物件之不可自訂的資訊和功能。 (繼承來源 ConfigurationSection)

方法

DeserializeElement(XmlReader, Boolean)	從組態檔讀取 XML。 (繼承來源 ConfigurationElement)
DeserializeSection(XmlReader)	從組態檔讀取 XML。 (繼承來源 ConfigurationSection)
Equals(Object)	將目前的 ConfigurationElement 執行個體與指定的物件相比較。 (繼承來源 ConfigurationElement)
GetHashCode()	取得表示目前 ConfigurationElement 執行個體的唯一值。 (繼承來源 ConfigurationElement)
GetRuntimeObject()	在衍生類別中覆寫時，傳回自訂物件。 (繼承來源 ConfigurationSection)
GetTransformedAssemblyString(String)	傳回指定之組件名稱的轉換版本。 (繼承來源 ConfigurationElement)
GetTransformedTypeString(String)	傳回指定之型別名稱的轉換版本。 (繼承來源 ConfigurationElement)
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
Init()	將 ConfigurationElement 物件設定為它的初始狀態。 (繼承來源 ConfigurationElement)
InitializeDefault()	用來初始化 ConfigurationElement 物件的預設值集。 (繼承來源 ConfigurationElement)
IsModified()	在衍生類別中進行實作時，指出這個組態項目自上次儲存或載入後是否已修改。 (繼承來源 ConfigurationSection)
IsReadOnly()	取得值，這個值表示 ConfigurationElement 物件是否唯讀。 (繼承來源 ConfigurationElement)
ListErrors(IList)	將這個 ConfigurationElement 物件中和所有子項目中的無效屬性錯誤加入傳遞的清單。 (繼承來源 ConfigurationElement)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
OnDeserializeUnrecognizedAttribute(String, String)	取得值，指出在還原序列化程序中是否遇到未知的屬性 (Attribute)。 (繼承來源 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	取得值，指出在還原序列化程序中是否遇到未知的項目。 (繼承來源 ConfigurationElement)
OnRequiredPropertyNotFound(String)	在找不到必要的屬性時擲回例外狀況 (Exception)。 (繼承來源 ConfigurationElement)
PostDeserialize()	還原序列化之後呼叫。 (繼承來源 ConfigurationElement)
PreSerialize(XmlWriter)	序列化之前呼叫。 (繼承來源 ConfigurationElement)
Reset(ConfigurationElement)	重設 ConfigurationElement 物件的內部狀態，包括鎖定和屬性的集合。 (繼承來源 ConfigurationElement)
ResetModified()	在衍生類別中實作時，將 IsModified() 方法的值重設為 `false`。 (繼承來源 ConfigurationSection)
SerializeElement(XmlWriter, Boolean)	在衍生類別中實作時，將此組態項目的內容寫入組態檔中。 (繼承來源 ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)	建立 XML 字串，在該字串的單一區段中，包含了要寫入檔案之 ConfigurationSection 物件的取消合併檢視。 (繼承來源 ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)	在衍生類別中實作時，將此組態項目的外部標記寫入組態檔中。 (繼承來源 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	將屬性設定為指定的值。 (繼承來源 ConfigurationElement)
SetReadOnly()	設定 IsReadOnly() 物件和所有子項目的 ConfigurationElement 屬性。 (繼承來源 ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)	指出當組態物件階層針對指定的 .NET Framework 目標版本串行化時，是否應該串行化指定的專案。 (繼承來源 ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)	指出當組態物件階層針對指定的 .NET Framework 目標版本串行化時，是否應該串行化指定的屬性。 (繼承來源 ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName)	指出當組態物件階層針對指定的 .NET Framework 目標版本串行化時，是否應該串行化目前的 ConfigurationSection 實例。 (繼承來源 ConfigurationSection)
ToString()	傳回代表目前物件的字串。 (繼承來源 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	修改 ConfigurationElement 物件，以移除不應該儲存的所有值。 (繼承來源 ConfigurationElement)

適用於

共用方式為

RoleManagerSection 類別

定義

範例

備註

建構函式

屬性

方法

適用於

另請參閱

其他資源