Share via


@ WebHandler

[このドキュメントはプレビューのみを目的としており、以降のリリースで変更される可能性があります。プレースホルダーとして空白のトピックが含まれています。]

HTTP ハンドラー (.ashx) ファイルの属性とコンパイル オプションを定義します。

<%@ WebHandler attribute="value" [attribute="value"...] %>

属性

  • Class
    ハンドラーを要求したときに動的にコンパイルされるクラス名を指定します。 この値は、IHttpHandler から継承する任意のクラスを参照できます。また、完全修飾クラス名を含めることができます。

  • CodeBehind
    ハンドラーに関連付けられているクラスを含むコンパイル済みのファイルの名前を指定します。 この属性は実行時には使用されません。

    注意

    この属性は、以前のバージョンの ASP.NET と互換性を保つために含まれています。

  • CompilerOptions
    ハンドラーをコンパイルするために使用されるコンテナー オプションを含む文字列を指定します。 C# と Visual Basic では、これはコンパイラ コマンド ライン スイッチのシーケンスです。 コンパイラ オプションの詳細については、「C# コンパイラ オプション」および「Visual Basic のコマンド ライン コンパイラ」を参照してください。

  • Debug
    デバッグ シンボルを含むハンドラーをコンパイルする場合は true、それ以外の場合は false を指定します。 この設定はパフォーマンスに影響するので、この属性を true に設定するのは開発中だけにしてください。

  • Description
    ハンドラーのテキスト説明を指定します。 ASP.NET パーサーでは、この値は無視されます。

  • Language
    ハンドラー内のすべてのコードをコンパイルするときに使用する言語を指定します。 値には、Visual Basic、C#、JScript など、.NET Framework のすべての言語を指定できます。 1 つのハンドラーには 1 つの言語のみを指定できます。

  • WarningLevel
    コンパイラが警告をエラーとして扱ってハンドラーのコンパイルを中止する、コンパイラの警告レベルを示します。 使用可能な警告レベルは 0 ~ 4 です。 詳細については、WarningLevel プロパティのトピックを参照してください。

解説

このディレクティブは、HTTP ハンドラーとして使用するファイルでのみ有効です。 既定で、ASP.NET は、.ashx という拡張子のファイルをハンドラーとして扱います。

注意

ハンドラーのファイル名に .ashx 拡張子を使用しない場合、IHttpHandler インターフェイスを実装する標準クラス (.cs または .vb ファイル) としてハンドラーを作成できます。ハンドラー クラス ファイルに、@ WebHandler ディレクティブは必須ではありません。その場合、ASP.NET で拡張子を登録する必要があります。詳細については、「How to: Register HTTP Handlers」を参照してください。

1 つのファイルには、@ WebHandler ディレクティブを 1 つだけ含むことができます。 1 つのハンドラーでは 1 つの言語だけを使用できるため、1 つの @ WebHandler ディレクティブには Language 属性を 1 つだけ定義できます。

注意

@ WebHandler ディレクティブには、全体のソース ファイルに適用される他のディレクティブと共通の属性が多数あります。たとえば、Web ページの .aspx ファイルに使用する @ Page ディレクティブなどです。

@ WebHandler ディレクティブに複数の属性を定義するには、属性と値の各ペアを単一のスペースで区切ります。 属性とその値とを結ぶ等号 (=) の左右どちらにも空白を挿入しないでください。

使用例

次のコード例は、ASP.NET ページ コンパイラに対して、Visual Basic をインライン コード言語として使用し、クラス名を使用するように指示します。

<%@ WebHandler Language="VB" Class="MyTestHandler" %>

参照

Reference

テキスト テンプレートのディレクティブの構文

@ Page

IHttpHandler

Handlers

概念

HTTP Handlers and HTTP Modules Overview