Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

358 lines
17 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="ProfileSettings" FullName="System.Web.Configuration.ProfileSettings">
<TypeSignature Language="C#" Value="public sealed class ProfileSettings : 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>The <see cref="T:System.Web.Configuration.ProfileSettings" /> class provides a way to programmatically access and modify the profiles element of the healthMonitoring section of a configuration file.</para>
<para>Event profiles determine how events are collected by ASP.NET and raised to providers. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Configures the ASP.NET event profiles. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ProfileSettings (string name);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="name" 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.ProfileSettings.Custom" />
</para>
</term>
<description>
<para>An empty string ("").</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.ProfileSettings.MaxLimit" />
</para>
</term>
<description>
<para>
<see cref="F:System.Int32.MaxValue" />.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.ProfileSettings.MinInstances" />
</para>
</term>
<description>
<para>1.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.Configuration.ProfileSettings.MinInterval" />
</para>
</term>
<description>
<para>
<see cref="F:System.TimeSpan.Zero" />.</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.ProfileSettings" /> class. using the specified name for the new instance of the class.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Web.Configuration.ProfileSettings" /> object to create.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ProfileSettings (string name, int minInstances, int maxLimit, TimeSpan minInterval);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="name" 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.ProfileSettings.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.ProfileSettings" /> class, using specified settings for the new instance of the class.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Web.Configuration.ProfileSettings" /> object to create.</param>
<param name="minInstances">
<attribution license="cc4" from="Microsoft" modified="false" />The minimum number of event occurrences 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 are raised.</param>
<param name="minInterval">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.TimeSpan" /> that specifies the minimum length of the interval between the times when two events of the same type are raised.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ProfileSettings (string name, int minInstances, int maxLimit, TimeSpan minInterval, string custom);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="name" 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>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Configuration.BufferModeSettings" /> class, using the specified settings for the new instance of the class.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Web.Configuration.ProfileSettings" /> object to create.</param>
<param name="minInstances">
<attribution license="cc4" from="Microsoft" modified="false" />The minimum number of event occurrences 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 are raised.</param>
<param name="minInterval">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.TimeSpan" /> that specifies the minimum 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 the <see cref="T:System.Web.Management.IWebEventCustomEvaluator" /> interface.</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. 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>This property specifies the maximum number of times an event of the same type will be raised. For example if the value is 10, 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. 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>This property specifies the minimum number of times an event occurs before an event is raised to the provider. For example, a value of 5 means that ASP.NET will not raise an event to the provider until the fifth instance of the event occurs. If the value is infinite (<see cref="F:System.Int32.MaxValue" />), then no event will be raised to the provider.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the minimum number of event occurrences 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 when the configuration section is saved. </para>
<para>If the value is <see cref="F:System.TimeSpan.Zero" />, then there is no minimum interval.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the minimum 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. Duplicate names may result in a loss of data when the configuration section is saved.</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.</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>
</Members>
</Type>