Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

WebBaseEvent.FormatCustomEventDetails Method

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.

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

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.