CustomError

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

CustomError クラス

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

CustomError セクションを構成して ASP.NET エラー コードをカスタム ページに割り当てます。このクラスは継承できません。

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

Visual Basic (宣言)

Public NotInheritable Class
 CustomError
    Inherits ConfigurationElement

Visual Basic (使用法)

Dim instance As CustomError

C#

public sealed class CustomError : ConfigurationElement

C++

public ref class CustomError sealed : public
 ConfigurationElement

J#

public final class CustomError extends ConfigurationElement

JScript

public final class CustomError extends
 ConfigurationElement

解説

CustomError クラスを使用すると、構成ファイルの error セクションにプログラムからアクセスして変更できます。この型は、CustomErrorCollection、CustomErrorsMode、および CustomErrorsSection を含むグループの一部です。

メモ
カスタム エラーを定義すると、ASP.NET で、IIS などの基のサービスによって通常であれば発行される標準のエラーに、カスタム エラーが割り当てられます。たとえば、ステータス コード 404 に対してカスタム エラーを定義した場合、ASP.NET は、存在しない .aspx ページが参照されたときにこのエラーを発行します。カスタム エラーは、ASP.NET が処理できる要素に対してのみ発行されます。たとえば、存在しない .htm ページが参照された場合、IIS は標準 404 エラーを発行します。

使用例

この例では、customErrors セクションの複数の属性に対して、宣言によって値を指定する方法を示しています。これらの属性には、CustomError クラスのメンバとしてもアクセスできます。

次の構成ファイルの例では、customErrors セクションに対して、宣言によって値を指定する方法を示しています。

<customErrors mode="RemoteOnly"
  defaultRedirect="customerror.htm">
    <error statusCode="404" redirect="customerror404.htm"/>
</customErrors>

CustomError クラスを使用する方法を次のコード例に示します。

Visual Basic

' Get the Web application configuration.
  Dim configuration _
  As System.Configuration.Configuration = _
  WebConfigurationManager.OpenWebConfiguration( _
  "/aspnetTest")

' Get the section.
  Dim customErrors As CustomErrorsSection =
 _
   CType(configuration.GetSection( _
   "system.web/customErrors"), CustomErrorsSection)

' Get the collection.
  Dim customErrorsCollection _
  As CustomErrorCollection = _
  customErrors.Errors

C#

// Get the Web application configuration.
Configuration configuration =
    WebConfigurationManager.OpenWebConfiguration(
    "/aspnetTest");

// Get the section.
CustomErrorsSection customErrors =
    (CustomErrorsSection)configuration.GetSection(
  "system.web/customErrors");

// Get the collection.
CustomErrorCollection customErrorsCollection =
    customErrors.Errors;

継承階層

System.Object
   System.Configuration.ConfigurationElement
    System.Web.Configuration.CustomError

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, 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

参照

関連項目
CustomError メンバ
System.Web.Configuration 名前空間
CustomErrorsSection
CustomErrorCollection
その他の技術情報
customErrors 要素 (ASP.NET 設定スキーマ)

CustomError コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

このコンストラクタは、.NET Framework インフラストラクチャをサポートします。独自に作成したコードから直接使用するためのものではありません。

CustomError クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    statusCode As Integer, _
    redirect As String _
)

Visual Basic (使用法)

Dim statusCode As Integer
Dim redirect As String

Dim instance As New CustomError(statusCode,
 redirect)

C#

public CustomError (
    int statusCode,
    string redirect
)

C++

public:
CustomError (
    int statusCode, 
    String^ redirect
)

J#

public CustomError (
    int statusCode, 
    String redirect
)

JScript

public function CustomError (
    statusCode : int, 
    redirect : String
)

パラメータ

statusCode

エラー ページへのリダイレクトの原因となる HTTP ステータス コード。

redirect

エラー コードに割り当てられるカスタム ページの URL。

解説

CustomError コンストラクタは、コードで直接使用するためのものではありません。ASP.NET 構成システムによって呼び出されます。CustomError クラスのインスタンスは、GetSection メソッドを使用して取得します。

プラットフォーム

Windows 98, Windows 2000 SP4, 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

参照

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

CustomError プロパティ

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	ElementInformation	ConfigurationElement オブジェクトのカスタマイズできない情報と機能を格納する ElementInformation オブジェクトを取得します。 ( ConfigurationElement から継承されます。)
	LockAllAttributesExcept	ロックされている属性のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockAllElementsExcept	ロックされている要素のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockAttributes	ロックされている属性のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockElements	ロックされている要素のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockItem	要素がロックされているかどうかを示す値を取得または設定します。 ( ConfigurationElement から継承されます。)
	Redirect	リダイレクト URL を取得または設定します。
	StatusCode	HTTP エラー ステータス コードを取得または設定します。

プロテクト プロパティ

	名前	説明
	ElementProperty	ConfigurationElement オブジェクト自体を表す ConfigurationElementProperty オブジェクトを取得します。 ( ConfigurationElement から継承されます。)
	EvaluationContext	ConfigurationElement オブジェクトの ContextInformation オブジェクトを取得します。 ( ConfigurationElement から継承されます。)
	Item	オーバーロードされます。 この ConfigurationElement オブジェクトのプロパティ、属性、または子要素を取得または設定します。 ( ConfigurationElement から継承されます。)
	Properties	プロパティのコレクションを取得します。 ( ConfigurationElement から継承されます。)

参照

関連項目

CustomError クラス
System.Web.Configuration 名前空間
CustomErrorsSection
CustomErrorCollection

その他の技術情報

customErrors 要素 (ASP.NET 設定スキーマ)

CustomError メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。
	GetHashCode	オーバーライドされます。 CustomError オブジェクトのハッシュ コードを取得します。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsReadOnly	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	DeserializeElement	構成ファイルから XML を読み取ります。 ( ConfigurationElement から継承されます。)
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	Init	ConfigurationElement オブジェクトを初期状態に設定します。 ( ConfigurationElement から継承されます。)
	InitializeDefault	ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。 ( ConfigurationElement から継承されます。)
	IsModified	派生クラスに実装された場合、この構成要素が最後の保存または読み込み以降に変更されたかどうかを示します。 ( ConfigurationElement から継承されます。)
	ListErrors	この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティのエラーを、渡されたリストに追加します。 ( ConfigurationElement から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	OnDeserializeUnrecognizedAttribute	逆シリカル化中に不明な属性が発生したかどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	OnDeserializeUnrecognizedElement	逆シリカル化中に不明な要素が発生したかどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	OnRequiredPropertyNotFound	必須プロパティが見つからなかったかどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	PostDeserialize	逆シリアル化後に呼び出されます。 ( ConfigurationElement から継承されます。)
	PreSerialize	シリアル化前に呼び出されます。 ( ConfigurationElement から継承されます。)
	Reset	ConfigurationElement オブジェクトの内部状態 (ロックやプロパティ コレクションなど) をリセットします。 ( ConfigurationElement から継承されます。)
	ResetModified	派生クラスに実装された場合、IsModified メソッドの値を false にリセットします。 ( ConfigurationElement から継承されます。)
	SerializeElement	派生クラスに実装されている場合、この構成要素の内容を構成ファイルに書き込みます。 ( ConfigurationElement から継承されます。)
	SerializeToXmlElement	派生クラスに実装されている場合、この構成要素の外側のタグを構成ファイルに書き込みます。 ( ConfigurationElement から継承されます。)
	SetPropertyValue	プロパティを指定した値に設定します。 ( ConfigurationElement から継承されます。)
	SetReadOnly	ConfigurationElement オブジェクトおよびすべてのサブ要素に IsReadOnly プロパティを設定します。 ( ConfigurationElement から継承されます。)
	Unmerge	保存しないすべての値を削除するには、ConfigurationElement オブジェクトを変更します。 ( ConfigurationElement から継承されます。)

参照

関連項目

CustomError クラス
System.Web.Configuration 名前空間
CustomErrorsSection
CustomErrorCollection

その他の技術情報

customErrors 要素 (ASP.NET 設定スキーマ)

CustomError メンバ

CustomError セクションを構成して ASP.NET エラー コードをカスタム ページに割り当てます。このクラスは継承できません。

CustomError データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	CustomError	CustomError クラスの新しいインスタンスを初期化します。

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	ElementInformation	ConfigurationElement オブジェクトのカスタマイズできない情報と機能を格納する ElementInformation オブジェクトを取得します。 (ConfigurationElement から継承されます。)
	LockAllAttributesExcept	ロックされている属性のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockAllElementsExcept	ロックされている要素のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockAttributes	ロックされている属性のコレクションを取得します。 (ConfigurationElement から継承されます。)
	LockElements	ロックされている要素のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockItem	要素がロックされているかどうかを示す値を取得または設定します。(ConfigurationElement から継承されます。)
	Redirect	リダイレクト URL を取得または設定します。
	StatusCode	HTTP エラー ステータス コードを取得または設定します。

プロテクト プロパティ

	名前	説明
	ElementProperty	ConfigurationElement オブジェクト自体を表す ConfigurationElementProperty オブジェクトを取得します。(ConfigurationElement から継承されます。)
	EvaluationContext	ConfigurationElement オブジェクトの ContextInformation オブジェクトを取得します。(ConfigurationElement から継承されます。)
	Item	オーバーロードされます。 この ConfigurationElement オブジェクトのプロパティ、属性、または子要素を取得または設定します。(ConfigurationElement から継承されます。)
	Properties	プロパティのコレクションを取得します。(ConfigurationElement から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。
	GetHashCode	オーバーライドされます。 CustomError オブジェクトのハッシュ コードを取得します。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsReadOnly	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	DeserializeElement	構成ファイルから XML を読み取ります。 (ConfigurationElement から継承されます。)
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	Init	ConfigurationElement オブジェクトを初期状態に設定します。 (ConfigurationElement から継承されます。)
	InitializeDefault	ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。 (ConfigurationElement から継承されます。)
	IsModified	派生クラスに実装された場合、この構成要素が最後の保存または読み込み以降に変更されたかどうかを示します。 (ConfigurationElement から継承されます。)
	ListErrors	この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティのエラーを、渡されたリストに追加します。 (ConfigurationElement から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	OnDeserializeUnrecognizedAttribute	逆シリカル化中に不明な属性が発生したかどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	OnDeserializeUnrecognizedElement	逆シリカル化中に不明な要素が発生したかどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	OnRequiredPropertyNotFound	必須プロパティが見つからなかったかどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	PostDeserialize	逆シリアル化後に呼び出されます。 (ConfigurationElement から継承されます。)
	PreSerialize	シリアル化前に呼び出されます。 (ConfigurationElement から継承されます。)
	Reset	ConfigurationElement オブジェクトの内部状態 (ロックやプロパティ コレクションなど) をリセットします。 (ConfigurationElement から継承されます。)
	ResetModified	派生クラスに実装された場合、IsModified メソッドの値を false にリセットします。 (ConfigurationElement から継承されます。)
	SerializeElement	派生クラスに実装されている場合、この構成要素の内容を構成ファイルに書き込みます。 (ConfigurationElement から継承されます。)
	SerializeToXmlElement	派生クラスに実装されている場合、この構成要素の外側のタグを構成ファイルに書き込みます。 (ConfigurationElement から継承されます。)
	SetPropertyValue	プロパティを指定した値に設定します。 (ConfigurationElement から継承されます。)
	SetReadOnly	ConfigurationElement オブジェクトおよびすべてのサブ要素に IsReadOnly プロパティを設定します。 (ConfigurationElement から継承されます。)
	Unmerge	保存しないすべての値を削除するには、ConfigurationElement オブジェクトを変更します。 (ConfigurationElement から継承されます。)

参照

関連項目

CustomError クラス
System.Web.Configuration 名前空間
CustomErrorsSection
CustomErrorCollection

その他の技術情報

customErrors 要素 (ASP.NET 設定スキーマ)