WebBaseEvent.FormatCustomEventDetails Method (WebEventFormatter)

 

Provides standard formatting of the event information.

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

public virtual void FormatCustomEventDetails(
	WebEventFormatter formatter
)

Parameters

formatter
Type: System.Web.Management.WebEventFormatter

A WebEventFormatter object that contains the formatted event information.

The FormatCustomEventDetails 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.

System_CAPS_noteNote

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

The following code example shows how to customize the FormatCustomEventDetails method.

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

    // Add custom data.
    formatter.AppendLine("");

    formatter.IndentationLevel += 1;

    formatter.TabSize = 4;

    formatter.AppendLine(
         "*SampleWebBaseEvent Start *");

    // Display custom event information.
    formatter.AppendLine(customCreatedMsg);
    formatter.AppendLine(customRaisedMsg);
    formatter.AppendLine(firingRecordInfo);

    formatter.AppendLine(
  "* SampleWebBaseEvent End *");


    formatter.IndentationLevel -= 1;

}

.NET Framework
Available since 2.0
Return to top
Show: