FormatToString Method
Collapse the table of content
Expand the table of content

WebRequestInformation.FormatToString Method (WebEventFormatter)

 

Formats the Web-request information.

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

public void FormatToString(
	WebEventFormatter formatter
)

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

}

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft