WebApplicationInformation.FormatToString メソッド

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

WebApplicationInformation.FormatToString メソッド

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

アプリケーション情報を書式設定します。

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

Visual Basic (宣言)

Public Sub FormatToString ( _
    formatter As WebEventFormatter _
)

Visual Basic (使用法)

Dim instance As WebApplicationInformation
Dim formatter As WebEventFormatter

instance.FormatToString(formatter)

C#

public void FormatToString (
    WebEventFormatter formatter
)

C++

public:
void FormatToString (
    WebEventFormatter^ formatter
)

J#

public void FormatToString (
    WebEventFormatter formatter
)

JScript

public function FormatToString (
    formatter : WebEventFormatter
)

パラメータ

formatter

Web の状態イベント情報の書式設定に使用するタブとインデントの設定を格納している WebEventFormatter。

解説

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

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

使用例

カスタム情報を所定の形式にする方法を次のコード例に示します。

Visual Basic

    '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 'FormatCustomEventDetails
End Class 'SampleWebApplicationInformation
 

C#

//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());
}

プラットフォーム

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

参照

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