mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Imported Upstream version 3.6.0

Browse Source 
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
This commit is contained in:
Jo Shields
2014-08-13 10:39:27 +01:00
commit a575963da9
50588 changed files with 8155799 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

114
mcs/class/System.Web/Documentation/en/System.Web.Management/EventNotificationType.xml Normal file
View File

@@ -0,0 +1,114 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="EventNotificationType" FullName="System.Web.Management.EventNotificationType">
<TypeSignature Language="C#" Value="public enum EventNotificationType" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Management.EventNotificationType" /> enumeration provides four notification types that specify how the notification should take place. The four notification types are as follows:</para>
<list type="bullet">
<item>
<para>
<see cref="F:System.Web.Management.EventNotificationType.Flush" />
</para>
</item>
<item>
<para>
<see cref="F:System.Web.Management.EventNotificationType.Regular" />
</para>
</item>
<item>
<para>
<see cref="F:System.Web.Management.EventNotificationType.Unbuffered" />
</para>
</item>
<item>
<para>
<see cref="F:System.Web.Management.EventNotificationType.Urgent" />
</para>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies the type of event notification.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Flush">
<MemberSignature Language="C#" Value="Flush" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.EventNotificationType</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The notification of an event is triggered by a requested flush.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Regular">
<MemberSignature Language="C#" Value="Regular" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.EventNotificationType</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The notification of an event is triggered on a regularly scheduled interval.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Unbuffered">
<MemberSignature Language="C#" Value="Unbuffered" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.EventNotificationType</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Every event is treated as if a flush has occurred.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Urgent">
<MemberSignature Language="C#" Value="Urgent" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.EventNotificationType</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Notification triggered by exceeding the urgent event threshold.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

130
mcs/class/System.Web/Documentation/en/System.Web.Management/IRegiisUtility.xml Normal file
View File

@@ -0,0 +1,130 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IRegiisUtility" FullName="System.Web.Management.IRegiisUtility">
<TypeSignature Language="C#" Value="public interface IRegiisUtility" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.Guid("C84F668A-CC3F-11D7-B79E-505054503030")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The utility functions provided by the <see cref="T:System.Web.Management.IRegiisUtility" /> interface support the system.web assembly registration.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides authorization utilities to support specific Web-application configuration, assembly registration, and assembly-key container manipulation.</para>
</summary>
</Docs>
<Members>
<Member MemberName="ProtectedConfigAction">
<MemberSignature Language="C#" Value="public void ProtectedConfigAction (long actionToPerform, string firstArgument, string secondArgument, string providerName, string appPath, string site, string cspOrLocation, int keySize, out IntPtr exception);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actionToPerform" Type="System.Int64" />
<Parameter Name="firstArgument" Type="System.String" />
<Parameter Name="secondArgument" Type="System.String" />
<Parameter Name="providerName" Type="System.String" />
<Parameter Name="appPath" Type="System.String" />
<Parameter Name="site" Type="System.String" />
<Parameter Name="cspOrLocation" Type="System.String" />
<Parameter Name="keySize" Type="System.Int32" />
<Parameter Name="exception" Type="System.IntPtr&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="actionToPerform">To be added.</param>
<param name="firstArgument">To be added.</param>
<param name="secondArgument">To be added.</param>
<param name="providerName">To be added.</param>
<param name="appPath">To be added.</param>
<param name="site">To be added.</param>
<param name="cspOrLocation">To be added.</param>
<param name="keySize">To be added.</param>
<param name="exception">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RegisterAsnetMmcAssembly">
<MemberSignature Language="C#" Value="public void RegisterAsnetMmcAssembly (int doReg, string assemblyName, string binaryDirectory, out IntPtr exception);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="doReg" Type="System.Int32" />
<Parameter Name="assemblyName" Type="System.String" />
<Parameter Name="binaryDirectory" Type="System.String" />
<Parameter Name="exception" Type="System.IntPtr&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="doReg">To be added.</param>
<param name="assemblyName">To be added.</param>
<param name="binaryDirectory">To be added.</param>
<param name="exception">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RegisterSystemWebAssembly">
<MemberSignature Language="C#" Value="public void RegisterSystemWebAssembly (int doReg, out IntPtr exception);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="doReg" Type="System.Int32" />
<Parameter Name="exception" Type="System.IntPtr&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="doReg">To be added.</param>
<param name="exception">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RemoveBrowserCaps">
<MemberSignature Language="C#" Value="public void RemoveBrowserCaps (out IntPtr exception);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="exception" Type="System.IntPtr&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="exception">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

58
mcs/class/System.Web/Documentation/en/System.Web.Management/IWebEventCustomEvaluator.xml Normal file
View File

@@ -0,0 +1,58 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IWebEventCustomEvaluator" FullName="System.Web.Management.IWebEventCustomEvaluator">
<TypeSignature Language="C#" Value="public interface IWebEventCustomEvaluator" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>ASP.NET health monitoring allows production and operations staff to manage deployed Web applications. The <see cref="N:System.Web.Management" /> namespace contains the health-event types responsible for packaging application health-status data and the provider types responsible for processing this data. It also contains supporting types that help during the management of health events.</para>
<para>This interface allows enabling or disabling the firing of a specific event. This is especially useful when you implement your own custom event and want to control the rate at which it is sent to the related provider for processing.</para>
<block subset="none" type="note">
<para>This interface does not control how often the event is raised. It only controls how often the event information is sent to the provider for processing.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Evaluates whether an event should be sent to the related provider for processing.</para>
</summary>
</Docs>
<Members>
<Member MemberName="CanFire">
<MemberSignature Language="C#" Value="public bool CanFire (System.Web.Management.WebBaseEvent raised_event, System.Web.Management.RuleFiringRecord record);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raised_event" Type="System.Web.Management.WebBaseEvent" />
<Parameter Name="record" Type="System.Web.Management.RuleFiringRecord" />
</Parameters>
<Docs>
<param name="raised_event">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the custom event evaluator returns true, the event is raised and then processed by the associated provider.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Evaluates whether an event should be raised.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the event should be raised; otherwise, false.</para>
</returns>
<param name="record">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.Management.RuleFiringRecord" /> containing information about the event. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

63
mcs/class/System.Web/Documentation/en/System.Web.Management/RuleFiringRecord.xml Normal file
View File

@@ -0,0 +1,63 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="RuleFiringRecord" FullName="System.Web.Management.RuleFiringRecord">
<TypeSignature Language="C#" Value="public sealed class RuleFiringRecord" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Management.RuleFiringRecord" /> class provides information that could be used to determine whether the firing of the event should be recorded.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents the firing record for an event that derives from the <see cref="T:System.Web.Management.WebManagementEvent" /> class and implements the <see cref="T:System.Web.Management.IWebEventCustomEvaluator" /> interface.</para>
</summary>
</Docs>
<Members>
<Member MemberName="LastFired">
<MemberSignature Language="C#" Value="public DateTime LastFired { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the last time that the event was last fired.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TimesRaised">
<MemberSignature Language="C#" Value="public int TimesRaised { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the total number of times that the event has been raised.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

72
mcs/class/System.Web/Documentation/en/System.Web.Management/SessionStateType.xml Normal file
View File

@@ -0,0 +1,72 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="SessionStateType" FullName="System.Web.Management.SessionStateType">
<TypeSignature Language="C#" Value="public enum SessionStateType" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Describes the session-state type used when installing a session-state database provider.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Custom">
<MemberSignature Language="C#" Value="Custom" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.SessionStateType</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Session-state data and stored procedures are placed in a custom data store.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Persisted">
<MemberSignature Language="C#" Value="Persisted" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.SessionStateType</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Session-state data and stored procedures are placed in the "ASPState" database. Session-state data will survive a restart of the database server.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Temporary">
<MemberSignature Language="C#" Value="Temporary" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.SessionStateType</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Session state data is stored in tempdb, and stored procedures are placed in the "ASPState" database. Session state data will not survive a restart of SQL Server.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

148
mcs/class/System.Web/Documentation/en/System.Web.Management/SqlFeatures.xml Normal file
View File

@@ -0,0 +1,148 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="SqlFeatures" FullName="System.Web.Management.SqlFeatures">
<TypeSignature Language="C#" Value="public enum SqlFeatures" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Attributes>
<Attribute>
<AttributeName>System.Flags</AttributeName>
</Attribute>
</Attributes>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This enumeration has a <see cref="T:System.FlagsAttribute" />, which means you can select two or more features by combining them with the &amp; (and) operator (the And operator in Visual Basic).</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies the ASP.Net features to install or remove using the methods provided by the <see cref="T:System.Web.Management.SqlServices" /> class.</para>
</summary>
</Docs>
<Members>
<Member MemberName="All">
<MemberSignature Language="C#" Value="All" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.SqlFeatures</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>All features.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Membership">
<MemberSignature Language="C#" Value="Membership" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.SqlFeatures</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The membership feature.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="None">
<MemberSignature Language="C#" Value="None" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.SqlFeatures</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>No features.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Personalization">
<MemberSignature Language="C#" Value="Personalization" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.SqlFeatures</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The personalization feature.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Profile">
<MemberSignature Language="C#" Value="Profile" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.SqlFeatures</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The profile feature.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RoleManager">
<MemberSignature Language="C#" Value="RoleManager" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.SqlFeatures</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The role manager feature.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SqlWebEventProvider">
<MemberSignature Language="C#" Value="SqlWebEventProvider" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.SqlFeatures</ReturnType>
</ReturnValue>
<Docs>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The Web event provider feature.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

203
mcs/class/System.Web/Documentation/en/System.Web.Management/WebApplicationInformation.xml Normal file
View File

@@ -0,0 +1,203 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="WebApplicationInformation" FullName="System.Web.Management.WebApplicationInformation">
<TypeSignature Language="C#" Value="public sealed class WebApplicationInformation" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>ASP.NET health monitoring allows production and operations staff to manage deployed Web applications. The <see cref="N:System.Web.Management" /> namespace contains the health-event types responsible for packaging application health-status data and the provider types responsible for processing this data. It also contains supporting types that help during the management of health events.</para>
<para>Instances of the <see cref="T:System.Web.Management.WebApplicationInformation" /> class contain information that is obtained using any of the types derived from the <see cref="T:System.Web.Management.WebManagementEvent" /> type. </para>
<para>Your application needs the appropriate permissions to access protected information provided by this type.</para>
<para>The following is an excerpt of a configuration file you could use to enable ASP.NET to log error events that contain application information. </para>
<code>&lt;healthMonitoring
enabled="true" heartBeatInterval="0"&gt;
&lt;rules&gt;
&lt;add
name="All Errors Default"
eventName="All Errors"
provider="EventLogProvider"
profile="Default"
minInterval="00:01:00" /&gt;
&lt;/rules&gt;
&lt;/healthMonitoring&gt;</code>
<block subset="none" type="note">
<para>In most cases you will be able to use the ASP.NET health-monitoring types as implemented, and you will control the health-monitoring system by specifying values in the healthMonitoring configuration section. You can also derive from the health-monitoring types to create your own custom events and providers. For an example of creating a custom event class, see the example provided in this topic.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides information associated with health events.</para>
</summary>
</Docs>
<Members>
<Member MemberName="ApplicationDomain">
<MemberSignature Language="C#" Value="public string ApplicationDomain { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the current application domain name.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ApplicationPath">
<MemberSignature Language="C#" Value="public string ApplicationPath { get; }" />
<MemberType>Property</MemberType>
<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>This property requires appropriate permissions to be accessed. Refer to the Permissions section.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the application physical path.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ApplicationVirtualPath">
<MemberSignature Language="C#" Value="public string ApplicationVirtualPath { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the application logical path.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="FormatToString">
<MemberSignature Language="C#" Value="public void FormatToString (System.Web.Management.WebEventFormatter formatter);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="formatter" Type="System.Web.Management.WebEventFormatter" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Management.WebApplicationInformation.FormatToString(System.Web.Management.WebEventFormatter)" /> method provides a uniform format for event information, which is useful if the event data must be logged and later presented to the user. It is called internally when the provider invokes one of the <see cref="Overload:System.Web.Management.WebBaseEvent.ToString" /> methods.</para>
<block subset="none" type="note">
<para>When formatting your custom event information for display, override the <see cref="M:System.Web.Management.WebApplicationInformation.FormatToString(System.Web.Management.WebEventFormatter)" /> method rather than the <see cref="M:System.Web.Management.WebApplicationInformation.ToString" /> method. This will avoid overwriting or tampering with sensitive system information.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Formats the application information.</para>
</summary>
<param name="formatter">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.Management.WebEventFormatter" /> that contains the tab and indentation settings used to format the Web health event information.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MachineName">
<MemberSignature Language="C#" Value="public string MachineName { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the application machine name.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Management.WebBaseEvent.ToString" /> method formats event information by calling the <see cref="M:System.Web.Management.WebApplicationInformation.FormatToString(System.Web.Management.WebEventFormatter)" /> method.</para>
<block subset="none" type="note">
<para>When formatting your custom event information for display, override the <see cref="M:System.Web.Management.WebApplicationInformation.FormatToString(System.Web.Management.WebEventFormatter)" /> method rather than this <see cref="M:System.Web.Management.WebApplicationInformation.ToString" /> method. This will avoid overwriting or tampering with sensitive system information.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Formats event information for display purposes.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The event information.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TrustLevel">
<MemberSignature Language="C#" Value="public string TrustLevel { get; }" />
<MemberType>Property</MemberType>
<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>This property requires appropriate permissions to be accessed. Refer to the Permissions section.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the application trust level.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

413
mcs/class/System.Web/Documentation/en/System.Web.Management/WebBaseEvent.xml Normal file
View File

@@ -0,0 +1,413 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="WebBaseEvent" FullName="System.Web.Management.WebBaseEvent">
<TypeSignature Language="C#" Value="public class WebBaseEvent" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>ASP.NET health monitoring allows production and operations staff to manage deployed Web applications. The <see cref="N:System.Web.Management" /> namespace contains the health-event types responsible for packaging application health-status data and the provider types responsible for processing this data. It also contains supporting types that help during the management of health events.</para>
<para>The <see cref="T:System.Web.Management.WebBaseEvent" /> class is the root of the inheritance tree for all the ASP.NET health-monitoring event types. It uses the <see cref="T:System.Web.Management.WebApplicationInformation" /> class to obtain application information that is available to its derived class.</para>
<block subset="none" type="note">
<para>In most cases you will be able to use the ASP.NET health-monitoring types as implemented, and you will control the health-monitoring system by specifying values in the &lt;healthMonitoring&gt; configuration section. You can also derive from the health-monitoring types to create your own custom events and providers. For an example of deriving from the <see cref="T:System.Web.Management.WebBaseEvent" /> class, see the example provided in this topic.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines the base class for the ASP.NET health-monitoring events.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected WebBaseEvent (string message, object event_source, int event_code);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="message" Type="System.String" />
<Parameter Name="event_source" Type="System.Object" />
<Parameter Name="event_code" Type="System.Int32" />
</Parameters>
<Docs>
<param name="event_source">To be added.</param>
<param name="event_code">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor is used internally by the ASP.NET health-monitoring system. You will never use it to create an instance of the <see cref="T:System.Web.Management.WebBaseEvent" /> class, but you can call this constructor when you implement your own event type that inherits from this class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Management.WebBaseEvent" /> class using the supplied parameters.</para>
</summary>
<param name="message">
<attribution license="cc4" from="Microsoft" modified="false" />The description of the event. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected WebBaseEvent (string message, object event_source, int event_code, int event_detail_code);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="message" Type="System.String" />
<Parameter Name="event_source" Type="System.Object" />
<Parameter Name="event_code" Type="System.Int32" />
<Parameter Name="event_detail_code" Type="System.Int32" />
</Parameters>
<Docs>
<param name="event_source">To be added.</param>
<param name="event_code">To be added.</param>
<param name="event_detail_code">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor is used internally by the ASP.NET health-monitoring system. You will never use it to create an instance of the <see cref="T:System.Web.Management.WebBaseEvent" /> class, but you can call this constructor when you implement your own event type that inherits from this class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Management.WebBaseEvent" /> class using the supplied parameters.</para>
</summary>
<param name="message">
<attribution license="cc4" from="Microsoft" modified="false" />The description of the raised event. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ApplicationInformation">
<MemberSignature Language="C#" Value="public static System.Web.Management.WebApplicationInformation ApplicationInformation { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Web.Management.WebApplicationInformation</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a <see cref="T:System.Web.Management.WebApplicationInformation" /> object that contains information about the current application being monitored.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EventCode">
<MemberSignature Language="C#" Value="public int EventCode { get; }" />
<MemberType>Property</MemberType>
<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>More information about the event is contained in the related <see cref="P:System.Web.Management.WebBaseEvent.Message" /> value.</para>
<block subset="none" type="note">
<para>If you inherit from the <see cref="T:System.Web.Management.WebBaseEvent" /> class, the event code you specify for your custom event must be greater than <see cref="F:System.Web.Management.WebEventCodes.WebExtendedBase" />.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the code value associated with the event.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EventDetailCode">
<MemberSignature Language="C#" Value="public int EventDetailCode { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the event detail code.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EventID">
<MemberSignature Language="C#" Value="public Guid EventID { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Guid</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the identifier associated with the event.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EventSequence">
<MemberSignature Language="C#" Value="public long EventSequence { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This is a counter that indicates how many instances of the event have been raised by the application.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the number of times the event has been raised by the application.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EventSource">
<MemberSignature Language="C#" Value="public object EventSource { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the object that raises the event.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EventTime">
<MemberSignature Language="C#" Value="public DateTime EventTime { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the time when the event was raised.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EventTimeUtc">
<MemberSignature Language="C#" Value="public DateTime EventTimeUtc { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the time when the event was raised.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="FormatCustomEventDetails">
<MemberSignature Language="C#" Value="public virtual void FormatCustomEventDetails (System.Web.Management.WebEventFormatter formatter);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="formatter" Type="System.Web.Management.WebEventFormatter" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Management.WebBaseEvent.FormatCustomEventDetails(System.Web.Management.WebEventFormatter)" /> method provides a uniform format for event information, which is useful if the event data must be logged and later presented to the user. It is called internally when the provider invokes one of the <see cref="Overload:System.Web.Management.WebBaseEvent.ToString" /> methods.</para>
<block subset="none" type="note">
<para>When you format your custom event information for display, override the <see cref="M:System.Web.Management.WebBaseEvent.FormatCustomEventDetails(System.Web.Management.WebEventFormatter)" /> method rather than the <see cref="Overload:System.Web.Management.WebBaseEvent.ToString" /> method. This will avoid overwriting or tampering with sensitive system information.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides standard formatting of the event information.</para>
</summary>
<param name="formatter">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.Management.WebEventFormatter" /> object that contains the formatted event information.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Message">
<MemberSignature Language="C#" Value="public string Message { get; }" />
<MemberType>Property</MemberType>
<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>This property describes the meaning of the <see cref="T:System.Web.Management.WebEventCodes" /> code value associated with the raised event.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the message that describes the event.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Raise">
<MemberSignature Language="C#" Value="public virtual void Raise ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If you override this method, the event raised is your custom event.</para>
<block subset="none" type="note">
<para>Medium trust or higher is required to raise an event.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Raises an event by notifying any configured provider that the event has occurred.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Raise">
<MemberSignature Language="C#" Value="public static void Raise (System.Web.Management.WebBaseEvent event_raised);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="event_raised" Type="System.Web.Management.WebBaseEvent" />
</Parameters>
<Docs>
<param name="event_raised">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method raises the specified event by notifying any configured provider that the event has occurred.</para>
<block subset="none" type="note">
<para>Medium trust or higher is required to raise an event.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Raises the specified event by notifying any configured provider that the event has occurred.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Management.WebBaseEvent.ToString" /> method is generally invoked by the provider that processes the event. The method ensures that the standard <see cref="T:System.Web.Management.WebApplicationInformation" /> object is provided with the event-specific data. It formats event information by calling the event-specific <see cref="M:System.Web.Management.WebBaseEvent.FormatCustomEventDetails(System.Web.Management.WebEventFormatter)" /> method.</para>
<block subset="none" type="note">
<para>When you format your custom event information for display, override the <see cref="M:System.Web.Management.WebBaseEvent.FormatCustomEventDetails(System.Web.Management.WebEventFormatter)" /> method rather than the <see cref="Overload:System.Web.Management.WebBaseEvent.ToString" /> method. This will avoid overwriting or tampering with sensitive system information.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Formats event information for display purposes.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The event information.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public virtual string ToString (bool include_app_info, bool include_custom_event_details);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="include_app_info" Type="System.Boolean" />
<Parameter Name="include_custom_event_details" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="include_app_info">To be added.</param>
<param name="include_custom_event_details">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Management.WebBaseEvent.ToString" /> method is generally invoked by the provider that processes the event. It formats event information by calling the event-specific <see cref="M:System.Web.Management.WebBaseEvent.FormatCustomEventDetails(System.Web.Management.WebEventFormatter)" /> method. If <paramref name="includeAppInfo" /> is true, the standard <see cref="T:System.Web.Management.WebApplicationInformation" /> object is provided with the event-specific data.</para>
<block subset="none" type="note">
<para>When you format your custom event information for display, override the <see cref="M:System.Web.Management.WebBaseEvent.FormatCustomEventDetails(System.Web.Management.WebEventFormatter)" /> method rather than the <see cref="Overload:System.Web.Management.WebBaseEvent.ToString" /> method. This will avoid overwriting or tampering with sensitive system information.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Formats event information for display purposes.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The event information.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

1456
mcs/class/System.Web/Documentation/en/System.Web.Management/WebEventCodes.xml Normal file
View File

File diff suppressed because it is too large Load Diff

123
mcs/class/System.Web/Documentation/en/System.Web.Management/WebEventFormatter.xml Normal file
View File

@@ -0,0 +1,123 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="WebEventFormatter" FullName="System.Web.Management.WebEventFormatter">
<TypeSignature Language="C#" Value="public class WebEventFormatter" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>ASP.NET health monitoring allows production and operations staff to manage deployed Web applications. The <see cref="N:System.Web.Management" /> namespace contains the health-event types responsible for packaging application health-status data and the provider types responsible for processing this data. It also contains supporting types that help during the management of health events.</para>
<para>The <see cref="T:System.Web.Management.WebEventFormatter" /> is a supporting type used to uniformly format event-related information, which is useful if the event data must be logged and later presented to the user.. </para>
<para>Instances of the <see cref="T:System.Web.Management.WebEventFormatter" /> class are passed as arguments to the formatting methods defined by the health-event types. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Formats ASP.NET health monitoring event information.</para>
</summary>
</Docs>
<Members>
<Member MemberName="AppendLine">
<MemberSignature Language="C#" Value="public void AppendLine (string s);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="s" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Management.WebEventFormatter.AppendLine(System.String)" /> method allows you to customize the event information by adding your own event-specific data.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Appends the specified string and a carriage return to the event information.</para>
</summary>
<param name="s">
<attribution license="cc4" from="Microsoft" modified="false" />The string to add to the event information.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IndentationLevel">
<MemberSignature Language="C#" Value="public int IndentationLevel { set; get; }" />
<MemberType>Property</MemberType>
<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.Management.WebEventFormatter.IndentationLevel" /> property allows you to control how the event information is indented. The base unit of indentation is defined by the <see cref="P:System.Web.Management.WebEventFormatter.TabSize" /> property. For each indentation level, you increase the indentation one tab.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the indentation level.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TabSize">
<MemberSignature Language="C#" Value="public int TabSize { set; get; }" />
<MemberType>Property</MemberType>
<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.Management.WebEventFormatter.TabSize" /> property allows you to control the tab size used when writing event information. The <see cref="P:System.Web.Management.WebEventFormatter.TabSize" /> determines the number of spaces per unit of indentation, controlled by <see cref="P:System.Web.Management.WebEventFormatter.IndentationLevel" /> property.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the tab size.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public string ToString ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Management.WebEventFormatter" /> uses an internal <see cref="T:System.Text.StringBuilder" /> variable to store the event information. This <see cref="M:System.Web.Management.WebEventFormatter.ToString" /> method allows you to get all the information in a string format.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the event information in string format.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The event information.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>