TraceContextEventArgs Class
TOC
Collapse the table of content
Expand the table of content

TraceContextEventArgs Class

 

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

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

System.Object
  System.EventArgs
    System.Web.TraceContextEventArgs

Public NotInheritable Class TraceContextEventArgs
	Inherits EventArgs

NameDescription
System_CAPS_pubmethodTraceContextEventArgs(ICollection)

Initializes a new instance of the TraceContextEventArgs class, using the provided collection of trace records.

NameDescription
System_CAPS_pubpropertyTraceRecords

Gets a collection of TraceContextRecord messages that are associated with the current request.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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="VB" Trace="true" %>
<script runat="server">
' The Page_Load method.
Private Sub Page_Load(sender As Object, e As EventArgs)

    ' Register a handler for the TraceFinished event.
    AddHandler Trace.TraceFinished, AddressOf OnTraceFinished

    ' Write a trace message.
    Trace.Write("Web Forms Infrastructure Methods", "USERMESSAGE: Page_Load complete.")
End Sub ' Page_Load

' A TraceContextEventHandler for the TraceFinished event.
Private Sub OnTraceFinished(sender As Object, e As TraceContextEventArgs)

    Dim r As TraceContextRecord
    Dim o As Object

    ' Iterate through the collection of trace records and write 
    ' them to the response stream.

    For Each o In e.TraceRecords
        r = CType(o, TraceContextRecord)
        Response.Write(String.Format("trace message: {0} <BR>", r.Message))
    Next

End Sub ' OnTraceFinished
</script>

.NET Framework
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft