WebBaseEvent.FormatCustomEventDetails(WebEventFormatter) Method

Reference

Definition

Namespace:: System.Web.Management

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides standard formatting of the event information.

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

public virtual void FormatCustomEventDetails (System.Web.Management.WebEventFormatter formatter);

abstract member FormatCustomEventDetails : System.Web.Management.WebEventFormatter -> unit
override this.FormatCustomEventDetails : System.Web.Management.WebEventFormatter -> unit

Public Overridable Sub FormatCustomEventDetails (formatter As WebEventFormatter)

Parameters

formatter: WebEventFormatter

A WebEventFormatter object that contains the formatted event information.

Examples

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;
}

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

        ' Add custom data.
        formatter.AppendLine("")

        formatter.IndentationLevel += 1
        
        formatter.TabSize = 4
        
        formatter.AppendLine("*SampleWebBaseEvent Start *")
        formatter.AppendLine("Custom information goes here")
        formatter.AppendLine("* SampleWebBaseEvent End *")
        ' Display custom event timing.
        formatter.AppendLine(customCreatedMsg)
        formatter.AppendLine(customRaisedMsg)
        formatter.IndentationLevel -= 1

    End Sub

Remarks

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.

Note

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.

Applies to

Compartilhar via