WebApplicationInformation.FormatToString(WebEventFormatter) Method

Definition

Namespace:

System.Web.Management

Assembly:

System.Web.dll

Formats the application 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)
{
    base.FormatCustomEventDetails(formatter);

    // Add custom data.
    formatter.AppendLine("");
    formatter.AppendLine(
    "Custom Application Information:");
    formatter.IndentationLevel += 1;

    // Display the application information.
    formatter.AppendLine(GetApplicationDomain());
    formatter.AppendLine(GetApplicationPath());
    formatter.AppendLine(GetApplicationVirtualPath());
    formatter.AppendLine(GetApplicationMachineName());
    formatter.AppendLine(GetApplicationTrustLevel());
    formatter.IndentationLevel -= 1;
    formatter.AppendLine(eventInfo.ToString());
}

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

        ' Add custom data.
        formatter.AppendLine( _
        "Custom Application Information:")
        formatter.IndentationLevel += 1

        ' Display the application information.
        formatter.AppendLine(GetApplicationDomain())
        formatter.AppendLine(GetApplicationPath())
        formatter.AppendLine(GetApplicationVirtualPath())
        formatter.AppendLine(GetApplicationMachineName())
        formatter.AppendLine(GetApplicationTrustLevel())
        formatter.IndentationLevel -= 1
        formatter.AppendLine(eventInfo.ToString())
    End Sub
End Class

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.

Note

When formatting your custom event information for display, override the FormatToString method rather than the ToString method. This will avoid overwriting or tampering with sensitive system information.