Export (0) Print
Expand All

TraceContextEventArgs Class

Provides a collection of trace records to any method that handles the TraceFinished event. This class cannot be inherited.

System.Object
  System.EventArgs
    System.Web.TraceContextEventArgs

Namespace:  System.Web
Assembly:  System.Web (in System.Web.dll)

public sealed class TraceContextEventArgs : EventArgs

The TraceContextEventArgs type exposes the following members.

  NameDescription
Public methodTraceContextEventArgsInitializes a new instance of the TraceContextEventArgs class, using the provided collection of trace records.
Top

  NameDescription
Public propertyTraceRecordsGets a collection of TraceContextRecord messages that are associated with the current request.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The TraceContextEventArgs class is used by the TraceContext class to provide access to trace records after all the tracing information is gathered during HTTP request processing. By adding an event handler delegate to handle the TraceFinished event, you can process the records, record them to your own data store, or provide them as input to a profiling tool.

The following code example demonstrates how you can register a TraceContextEventHandler delegate to handle the TraceFinished event. In this example, the OnTraceFinished method accesses the collection of TraceContextRecord objects through the TraceRecords property, iterates through them, and writes them to the response stream.

<%@ Page language="c#" Trace="true" %>
<script runat="server">
void Page_Load(object sender, EventArgs e)
{
    // Register a handler for the TraceFinished event.
    Trace.TraceFinished += new 
        TraceContextEventHandler(this.OnTraceFinished);

    // Write a trace message.
    Trace.Write("Web Forms Infrastructure Methods", "USERMESSAGE: Page_Load complete.");
}

// A TraceContextEventHandler for the TraceFinished event.
void OnTraceFinished(object sender, TraceContextEventArgs e)
{
    TraceContextRecord r = null;    

    // Iterate through the collection of trace records and write 
    // them to the response stream.
    foreach(object o in e.TraceRecords)
    {
        r = (TraceContextRecord)o;
        Response.Write(String.Format("trace message: {0} <BR>", r.Message));
    }
}       
</script>

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft