476 lines
23 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="utf-8"?>
<Type Name="RuleSettings" FullName="System.Web.Configuration.RuleSettings">
<TypeSignature Language="C#" Value="public sealed class RuleSettings : System.Configuration.ConfigurationElement" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.ConfigurationElement</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Event rules determine which event, using which profile, is fired to which provider. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Configures the ASP.NET event rules. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RuleSettings (string name, string eventName, string provider);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="eventName" Type="System.String" />
<Parameter Name="provider" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The following table shows the default settings that are used for this 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.RuleSettings.Custom" />
</para>
</term>
<description>
<para>An empty string ("").</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RuleSettings.MaxLimit" />
</para>
</term>
<description>
<para>
<see cref="F:System.Int32.MaxValue" />.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RuleSettings.MinInstances" />
</para>
</term>
<description>
<para>1.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RuleSettings.MinInterval" />
</para>
</term>
<description>
<para>0 ticks.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.RuleSettings.Profile" />
</para>
</term>
<description>
<para>An empty string ("").</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.RuleSettings" /> class using default settings; however, the name, event name, and provider are specified.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Web.Configuration.RuleSettings" /> object to create.</param>
<param name="eventName">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Web.Configuration.EventMappingSettings" /> object this rule applies to.</param>
<param name="provider">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Configuration.ProviderSettings" /> object this rule applies to.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RuleSettings (string name, string eventName, string provider, string profile, int minInstances, int maxLimit, TimeSpan minInterval);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="eventName" Type="System.String" />
<Parameter Name="provider" Type="System.String" />
<Parameter Name="profile" Type="System.String" />
<Parameter Name="minInstances" Type="System.Int32" />
<Parameter Name="maxLimit" Type="System.Int32" />
<Parameter Name="minInterval" Type="System.TimeSpan" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The following table shows the default settings that are used for this 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.RuleSettings.Custom" />
</para>
</term>
<description>
<para>An empty string ("").</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.RuleSettings" /> class where all values except those of the <see cref="P:System.Web.Configuration.RuleSettings.Custom" /> class are specified.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Web.Configuration.RuleSettings" /> object to create.</param>
<param name="eventName">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Web.Configuration.EventMappingSettings" /> object this rule applies to.</param>
<param name="provider">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Configuration.ProviderSettings" /> object this rule applies to.</param>
<param name="profile">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Web.Configuration.ProfileSettings" /> object this rule applies to.</param>
<param name="minInstances">
<attribution license="cc4" from="Microsoft" modified="false" />The minimum number of occurrences of the same type of event that can occur before the event is raised to the provider. </param>
<param name="maxLimit">
<attribution license="cc4" from="Microsoft" modified="false" />The maximum number of times events of the same type can be raised.</param>
<param name="minInterval">
<attribution license="cc4" from="Microsoft" modified="false" />The minimum time interval between two events of the same type.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RuleSettings (string name, string eventName, string provider, string profile, int minInstances, int maxLimit, TimeSpan minInterval, string custom);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="eventName" Type="System.String" />
<Parameter Name="provider" Type="System.String" />
<Parameter Name="profile" Type="System.String" />
<Parameter Name="minInstances" Type="System.Int32" />
<Parameter Name="maxLimit" Type="System.Int32" />
<Parameter Name="minInterval" Type="System.TimeSpan" />
<Parameter Name="custom" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You must provide every setting for this constructor.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Configuration.BufferModeSettings" /> class where all values are specified.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Web.Configuration.RuleSettings" /> object to create.</param>
<param name="eventName">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Web.Configuration.EventMappingSettings" /> object this rule applies to.</param>
<param name="provider">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Configuration.ProviderSettings" /> object this rule applies to.</param>
<param name="profile">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Web.Configuration.ProfileSettings" /> object this rule applies to.</param>
<param name="minInstances">
<attribution license="cc4" from="Microsoft" modified="false" />The minimum number of occurrences of an event of the same type before the event is fired to the provider. </param>
<param name="maxLimit">
<attribution license="cc4" from="Microsoft" modified="false" />The maximum number of times events of the same type are fired.</param>
<param name="minInterval">
<attribution license="cc4" from="Microsoft" modified="false" />The minimum time interval between two events of the same type.</param>
<param name="custom">
<attribution license="cc4" from="Microsoft" modified="false" />The fully qualified type of a custom class that implements <see cref="T:System.Web.Management.IWebEventCustomEvaluator" />.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Custom">
<MemberSignature Language="C#" Value="public string Custom { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("custom", DefaultValue="")</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 type reference is formed as follows (items in brackets are not required): Namespace.Typename, Assemblyname[,] [Version=x,] [Culture=y,] [PublicKeyToken=z]. For example, "ExampleNameSpace.ExampleType, Example.Assembly, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%"</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the fully qualified type of a custom class that implements <see cref="T:System.Web.Management.IWebEventCustomEvaluator" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EventName">
<MemberSignature Language="C#" Value="public string EventName { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("eventName", DefaultValue="", Options=System.Configuration.ConfigurationPropertyOptions.IsRequired)</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="T:System.Web.Configuration.EventMappingSettings" /> object referenced by this property must be contained by the same <see cref="T:System.Web.Configuration.HealthMonitoringSection" /> object that also contains this <see cref="T:System.Web.Configuration.RuleSettings" /></para>
<para>object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the name of the <see cref="T:System.Web.Configuration.EventMappingSettings" /> object this rule applies to.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MaxLimit">
<MemberSignature Language="C#" Value="public int MaxLimit { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("maxLimit", DefaultValue="2147483647")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Configuration.IntegerValidator(MinValue=0, MaxValue=2147483647)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Configuration.InfiniteIntConverter))</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>This property must have a value greater than zero. Invalid values may cause an exception to be thrown when the configuration section is saved.</para>
<para>This represents the maximum number of times an event of the same type will be raised. For example, if the value is 10, then the event will be raised 10 times and ignored thereafter.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the maximum number of times events of the same type are raised.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MinInstances">
<MemberSignature Language="C#" Value="public int MinInstances { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("minInstances", DefaultValue="1")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Configuration.IntegerValidator(MinValue=1, MaxValue=2147483647)</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>This property must have a value greater than zero. Invalid values may cause an exception to be thrown when the configuration section is saved.</para>
<para>This represents the minimum number of times an event occurs before an event is raised to the provider. For example, if the return value is 5, then ASP.NET will not raise an event to the provider until the fifth instance of the event occurs.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the minimum number of occurrences of the same type of event before the event is raised to the provider.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MinInterval">
<MemberSignature Language="C#" Value="public TimeSpan MinInterval { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("minInterval", DefaultValue="00:00:00")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Configuration.InfiniteTimeSpanConverter))</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 value can be made infinite by setting it to <see cref="F:System.Int32.MaxValue" />. Invalid values may cause an exception to be thrown when the configuration section is saved.</para>
<para>If the value is zero, then there is no minimum interval.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the minimum time interval between two events of the same type.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("name", DefaultValue="", Options=System.Configuration.ConfigurationPropertyOptions.IsRequired | System.Configuration.ConfigurationPropertyOptions.IsKey)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Configuration.StringValidator(MinLength=1)</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>A unique name is required. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the name of the <see cref="T:System.Web.Configuration.RuleSettings" /> object.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Profile">
<MemberSignature Language="C#" Value="public string Profile { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("profile", DefaultValue="")</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="T:System.Web.Configuration.ProfileSettings" /> object referenced by this property must be contained by the same <see cref="T:System.Web.Configuration.HealthMonitoringSection" /> object that also contains this <see cref="T:System.Web.Configuration.RuleSettings" /></para>
<para>object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the name of the <see cref="T:System.Web.Configuration.ProfileSettings" /> object this rule applies to.</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="Provider">
<MemberSignature Language="C#" Value="public string Provider { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("provider", DefaultValue="")</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="T:System.Configuration.ProviderSettings" /> object referenced by this property must be contained by the same <see cref="T:System.Web.Configuration.HealthMonitoringSection" /> object that also contains this <see cref="T:System.Web.Configuration.RuleSettings" /> object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the name of the <see cref="T:System.Configuration.ProviderSettings" /> object this rule applies to.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>