mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
linux-packaging-mono/mcs/class/System.Web/Documentation/en/System.Web.Configuration/RoleManagerSection.xml

571 lines
28 KiB
XML
Raw Normal View History

Imported Upstream version 3.6.0 Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00
<?xml version="1.0" encoding="utf-8"?>
<Type Name="RoleManagerSection" FullName="System.Web.Configuration.RoleManagerSection">
<TypeSignature Language="C#" Value="public sealed class RoleManagerSection : System.Configuration.ConfigurationSection" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.ConfigurationSection</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Configuration.RoleManagerSection" /> class provides a way to programmatically access and modify the content of the roleManager section of the configuration file.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines configuration settings that are used to support the role management infrastructure of Web applications. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RoleManagerSection ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Configuration.RoleManagerSection.#ctor" /> constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the <see cref="T:System.Web.Configuration.RoleManagerSection" /> class by using the <see cref="M:System.Configuration.Configuration.GetSection(System.String)" /> method.</para>
<para>The following table shows the default settings that are used for the <see cref="M:System.Web.Configuration.RoleManagerSection.#ctor" /> constructor.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Property</para>
</term>
<description>
<para>Default value</para>
</description>
</item>
</listheader>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RoleManagerSection.Enabled" />
</para>
</term>
<description>
<para>false</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RoleManagerSection.CacheRolesInCookie" />
</para>
</term>
<description>
<para>false</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RoleManagerSection.CookieName" />
</para>
</term>
<description>
<para>".ASPXROLES"</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RoleManagerSection.CookiePath" />
</para>
</term>
<description>
<para>"/"</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RoleManagerSection.CookieProtection" />
</para>
</term>
<description>
<para>All</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RoleManagerSection.CookieRequireSSL" />
</para>
</term>
<description>
<para>false</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RoleManagerSection.CookieSlidingExpiration" />
</para>
</term>
<description>
<para>true</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RoleManagerSection.CookieTimeout" />
</para>
</term>
<description>
<para>30, in minutes</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RoleManagerSection.CreatePersistentCookie" />
</para>
</term>
<description>
<para>false</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RoleManagerSection.DefaultProvider" />
</para>
</term>
<description>
<para>"AspNetSqlRoleProvider"</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RoleManagerSection.Domain" />
</para>
</term>
<description>
<para>An empty string ("")</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RoleManagerSection.MaxCachedResults" />
</para>
</term>
<description>
<para>25</para>
</description>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Configuration.RoleManagerSection" /> class by using default settings.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CacheRolesInCookie">
<MemberSignature Language="C#" Value="public bool CacheRolesInCookie { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("cacheRolesInCookie", DefaultValue=false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Configuration.RoleManagerSection.CacheRolesInCookie" /> property returns a Boolean value indicating whether cookie storage for role names is enabled.</para>
<para>When the <see cref="P:System.Web.Configuration.RoleManagerSection.CacheRolesInCookie" /> property is set to true in the configuration file, role information for each user is stored in a cookie on the client. When role management checks to determine whether a user is in a particular role, the roles cookie is checked before calling the role provider to check the list of roles at the data source. The cookie is dynamically updated on the client to cache the most recently validated role names.</para>
<para>You can improve the reliability of the role names that are cached in a cookie by specifying a <see cref="P:System.Web.Configuration.RoleManagerSection.CookieProtection" /> property when you configure the roleManager section of the configuration file. The default <see cref="P:System.Web.Configuration.RoleManagerSection.CookieProtection" /> property is All, which encrypts role names in the cookie and validates that the cookie contents have not been altered.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the current user's roles are cached in a cookie.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CookieName">
<MemberSignature Language="C#" Value="public string CookieName { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("cookieName", DefaultValue=".ASPXROLES")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Configuration.StringValidator(MinLength=1)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Configuration.WhiteSpaceTrimStringConverter))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Configuration.RoleManagerSection.CookieName" /> property returns the name of the cookie that is used to cache role names. You can specify the name of the cookie where roles are cached for your application by setting the cookieName attribute in the Web.config file for your ASP.NET application. This is useful when you want to uniquely identify a cookie for your application or when a cookie is shared across multiple applications.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the name of the cookie that is used to cache role names.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CookiePath">
<MemberSignature Language="C#" Value="public string CookiePath { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("cookiePath", DefaultValue="/")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Configuration.StringValidator(MinLength=1)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Configuration.WhiteSpaceTrimStringConverter))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can specify the path of the cookie where role names are cached for your application by setting the cookiePath attribute in the Web.config file for your ASP.NET application. The <see cref="P:System.Web.Configuration.RoleManagerSection.CookiePath" /> property returns the value of the cookiePath attribute from the Web.config file. The path is case sensitive.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the virtual path of the cookie that is used to cache role names.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CookieProtection">
<MemberSignature Language="C#" Value="public System.Web.Security.CookieProtection CookieProtection { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("cookieProtection", DefaultValue="All")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.Security.CookieProtection</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Configuration.RoleManagerSection.CookieProtection" /> property describes how information in a cookie is securely stored. You can specify the security type of the cookie where roles are cached for your application by setting the cookieProtection attribute in the Web.config file for your ASP.NET application. The cookieProtection attribute takes a <see cref="T:System.Web.Security.CookieProtection" /> enumeration value of All, Encryption, None, or Validation. The default is All. Be sure to use the default value for the <see cref="P:System.Web.Configuration.RoleManagerSection.CookieProtection" /> property if you want both data validation and encryption to help protect the cookie. To improve the protection of your cookie, you can also set the <see cref="P:System.Web.Configuration.RoleManagerSection.CookieRequireSSL" /> property to true.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the type of security that is used to protect the cookie that caches role names.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CookieRequireSSL">
<MemberSignature Language="C#" Value="public bool CookieRequireSSL { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("cookieRequireSSL", DefaultValue=false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can specify whether SSL is required to return the role names cookie to the server by setting the cookieRequireSSL attribute in the Web.config file for your ASP.NET application.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the cookie that is used to cache role names requires a Secure Sockets Layer (SSL) connection in order to be returned to the server.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CookieSlidingExpiration">
<MemberSignature Language="C#" Value="public bool CookieSlidingExpiration { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("cookieSlidingExpiration", DefaultValue=true)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can specify whether the cookie that is used to cache role names is periodically reset or expired at a fixed point in time by using the cookieSlidingExpiration attribute in the Web.config file for your ASP.NET application. If true, the cookie expiration is initially set to the current date and time plus the <see cref="P:System.Web.Configuration.RoleManagerSection.CookieTimeout" /> property, in minutes. While the user continues to actively use the ASP.NET application, the expiration date and time of the cookie is automatically refreshed, if there is less than half of the <see cref="P:System.Web.Configuration.RoleManagerSection.CookieTimeout" /> remaining. The default is true.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the cookie that is used to cache role names will be reset periodically. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CookieTimeout">
<MemberSignature Language="C#" Value="public TimeSpan CookieTimeout { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Configuration.TimeSpanMinutesOrInfiniteConverter))</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("cookieTimeout", DefaultValue="00:30:00")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Configuration.TimeSpanValidator(MinValueString="00:00:00", MaxValueString="10675199.02:48:05.4775807")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Configuration.RoleManagerSection.CookieTimeout" /> property sets a value specifying the number of minutes before the role names cookie expires. The default is 30 minutes. If the <see cref="P:System.Web.Configuration.RoleManagerSection.CookieSlidingExpiration" /> property is false, the <see cref="P:System.Web.Configuration.RoleManagerSection.CookieTimeout" /> property is ignored.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the number of minutes before the cookie that is used to cache role names expires.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreatePersistentCookie">
<MemberSignature Language="C#" Value="public bool CreatePersistentCookie { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("createPersistentCookie", DefaultValue=false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Configuration.RoleManagerSection.CreatePersistentCookie" /> property indicates whether or not the cookie that is used to cache role names should be a session-based cookie, which means that the cookie is lost when the browser is closed, or a persistent cookie, which means that the cookie is available across browser sessions. The default is false, which indicates that a session-based cookie is used to cache role names.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether a session-based cookie or a persistent cookie is used to cache role names. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DefaultProvider">
<MemberSignature Language="C#" Value="public string DefaultProvider { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("defaultProvider", DefaultValue="AspNetSqlRoleProvider")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Configuration.StringValidator(MinLength=1)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Configuration.WhiteSpaceTrimStringConverter))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Configuration.RoleManagerSection.DefaultProvider" /> property must match a named value in the providers subsection of the roleManager section of a configuration file. An empty string ("") is not a valid value for the <see cref="P:System.Web.Configuration.RoleManagerSection.DefaultProvider" /> property.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the name of the default provider that is used to manage roles. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Domain">
<MemberSignature Language="C#" Value="public string Domain { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("domain")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Configuration.RoleManagerSection.Domain" /> property is set in the configuration for an ASP.NET application by using the domain attribute of the roleManager configuration element. If no value is specified in the configuration for the domain attribute, the <see cref="P:System.Web.Configuration.RoleManagerSection.Domain" /> property returns null and the role names cookie domain defaults to the behavior of the <see cref="P:System.Web.HttpCookie.Domain" /> property. The default is an empty string.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the name of the domain that is associated with the cookie that is used to cache role names. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Enabled">
<MemberSignature Language="C#" Value="public bool Enabled { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("enabled", DefaultValue=false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Configuration.RoleManagerSection.Enabled" /> property returns a Boolean value indicating whether or not the ASP.NET role management feature can be accessed at run time.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the ASP.NET role management feature is enabled. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MaxCachedResults">
<MemberSignature Language="C#" Value="public int MaxCachedResults { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("maxCachedResults", DefaultValue=25)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.Roles.MaxCachedResults" /> property returns an integer indicating the maximum number of roles that ASP.NET caches in the role cookie. The default is 25.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the maximum number of roles that ASP.NET caches in the role cookie. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationPropertyCollection Properties { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Configuration.ConfigurationPropertyCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Providers">
<MemberSignature Language="C#" Value="public System.Configuration.ProviderSettingsCollection Providers { get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("providers")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Configuration.ProviderSettingsCollection</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Role management providers are components that provide access to the types of roles for a site. You can specify role management providers in the providers subsection of the roleManager section of a configuration file.</para>
<para>The <see cref="P:System.Web.Configuration.RoleManagerSection.DefaultProvider" /> property specifies the provider that is used by default.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a <see cref="T:System.Configuration.ProviderSettingsCollection" /> object of <see cref="T:System.Configuration.ProviderSettings" /> elements.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>
Reference in New Issue Copy Permalink