WebRequestInformation.FormatToString(WebEventFormatter) Method

Definition

Namespace:

System.Web.Management

Assembly:

System.Web.dll

Formats the Web-request information.

public:
 void FormatToString(System::Web::Management::WebEventFormatter ^ formatter);

public void FormatToString (System.Web.Management.WebEventFormatter formatter);

member this.FormatToString : System.Web.Management.WebEventFormatter -> unit

Public Sub FormatToString (formatter As WebEventFormatter)

Parameters

formatter

WebEventFormatter

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

Examples

The following code example shows how to format custom information.

// Formats Web request event information.
public override void FormatCustomEventDetails(
 WebEventFormatter formatter)
{

    // 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());
}

' 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

Remarks

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.