WebBaseEvent.FormatCustomEventDetails メソッド

.NET Framework クラス ライブラリ リファレンス

WebBaseEvent.FormatCustomEventDetails メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

イベント情報の標準的な形式を提供します。

名前空間: System.Web.Management
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Overridable Sub FormatCustomEventDetails
 ( _
    formatter As WebEventFormatter _
)

Visual Basic (使用法)

Dim instance As WebBaseEvent
Dim formatter As WebEventFormatter

instance.FormatCustomEventDetails(formatter)

C#

public virtual void FormatCustomEventDetails
 (
    WebEventFormatter formatter
)

C++

public:
virtual void FormatCustomEventDetails (
    WebEventFormatter^ formatter
)

J#

public void FormatCustomEventDetails (
    WebEventFormatter formatter
)

JScript

public function FormatCustomEventDetails (
    formatter : WebEventFormatter
)

パラメータ

formatter

フォーマットされたイベント情報を格納する WebEventFormatter。

解説

FormatCustomEventDetails メソッドを使用すると、イベント情報の形式を統一できます。イベント データのログを記録しておき、後でユーザーに提示する場合に有用です。このメソッドは、プロバイダが ToString メソッドのどれかを呼び出したときに内部的に呼び出されます。

メモ
カスタム イベント情報を表示用に書式設定する場合は、ToString メソッドではなく、FormatCustomEventDetails メソッドをオーバーライドします。これにより、重要なシステム情報に対する上書きや不正な変更を防げます。

使用例

FormatCustomEventDetails メソッドをカスタマイズする方法を次のコード例に示します。

Visual Basic

    '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 'FormatCustomEventDetails

C#

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

}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WebBaseEvent クラス
WebBaseEvent メンバ
System.Web.Management 名前空間