WebRequestInformation.FormatToString Method (WebEventFormatter)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Formats the Web-request information.

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

Public Sub FormatToString (
	formatter As WebEventFormatter
)

Parameters

formatter
Type: System.Web.Management.WebEventFormatter

The WebEventFormatter that contains the tab and indentation settings used to format the Web health event information.

The FormatToString 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 ToString methods.

The following code example shows how to format custom information.

' Formats Web request event information.
 Public Overrides Sub FormatCustomEventDetails( _
 ByVal formatter As WebEventFormatter)

     ' Add custom data.
     formatter.AppendLine("")
     formatter.AppendLine("Custom Request Information:")

     formatter.IndentationLevel += 1

     ' Display the request information obtained 
     ' using the WebRequestInformation object.
     formatter.AppendLine(GetRequestPath())
     formatter.AppendLine(GetRequestUrl())
     formatter.AppendLine(GetRequestUserHostAdddress())
     formatter.AppendLine(GetRequestPrincipal())
     formatter.IndentationLevel -= 1

     formatter.AppendLine(eventInfo.ToString())
 End Sub 'FormatCustomEventDetails 

.NET Framework
Available since 2.0
Return to top
Show: