CustomError Class
Configures a CustomError section to map an ASP.NET error code to a custom page. This class cannot be inherited.
Assembly: System.Web (in System.Web.dll)
| Name | Description | |
|---|---|---|
 | CustomError(Int32, String^) | This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the CustomError class. |
| Name | Description | |
|---|---|---|
 | CurrentConfiguration | Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.(Inherited from ConfigurationElement.) |
| ElementInformation | Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.) |
 | ElementProperty | Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.(Inherited from ConfigurationElement.) |
| Item[ConfigurationProperty^] | Gets or sets a property or attribute of this configuration element.(Inherited from ConfigurationElement.) |
| Item[String^] | Gets or sets a property, attribute, or child element of this configuration element.(Inherited from ConfigurationElement.) |
| LockAllAttributesExcept | Gets the collection of locked attributes.(Inherited from ConfigurationElement.) |
| LockAllElementsExcept | Gets the collection of locked elements.(Inherited from ConfigurationElement.) |
| LockAttributes | Gets the collection of locked attributes (Inherited from ConfigurationElement.) |
| LockElements | Gets the collection of locked elements.(Inherited from ConfigurationElement.) |
| LockItem | Gets or sets a value indicating whether the element is locked.(Inherited from ConfigurationElement.) |
| Properties | Gets the collection of properties.(Inherited from ConfigurationElement.) |
| Redirect | Gets or sets the redirection URL. |
| StatusCode | Gets or sets the HTTP error status code. |
| Name | Description | |
|---|---|---|
 | DeserializeElement(XmlReader^, Boolean) | Reads XML from the configuration file.(Inherited from ConfigurationElement.) |
| Equals(Object^) | Compares CustomError errors.(Overrides ConfigurationElement::Equals(Object^).) |
| GetHashCode() | Gets the CustomError object hash code.(Overrides ConfigurationElement::GetHashCode().) |
| GetType() | |
| Init() | Sets the ConfigurationElement object to its initial state.(Inherited from ConfigurationElement.) |
| InitializeDefault() | Used to initialize a default set of values for the ConfigurationElement object.(Inherited from ConfigurationElement.) |
| IsModified() | Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class.(Inherited from ConfigurationElement.) |
| IsReadOnly() | Gets a value indicating whether the ConfigurationElement object is read-only.(Inherited from ConfigurationElement.) |
| Reset(ConfigurationElement^) | Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.(Inherited from ConfigurationElement.) |
| ResetModified() | Resets the value of the IsModified method to false when implemented in a derived class.(Inherited from ConfigurationElement.) |
| SerializeElement(XmlWriter^, Boolean) | Writes the contents of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.) |
| SerializeToXmlElement(XmlWriter^, String^) | Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.) |
| SetReadOnly() | Sets the IsReadOnly property for the ConfigurationElement object and all subelements.(Inherited from ConfigurationElement.) |
| ToString() | Returns a string that represents the current object.(Inherited from Object.) |
| Unmerge(ConfigurationElement^, ConfigurationElement^, ConfigurationSaveMode) | Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.) |
The CustomError class provides a way to programmatically access and modify the error section of a configuration file. This type is part of a group that includes the CustomErrorCollection, CustomErrorsMode, and CustomErrorsSection.
 Note |
|---|
When you define a custom error, ASP.NET assigns to it the standard error normally issued by the underlying service, such as IIS. For instance, if you define a custom error for the status code 404, ASP.NET will issue it anytime you refer to a non-existing .aspx page. The custom errors are only issued for those elements handled by ASP.NET. For instance, if you refer to a non-existing .htm page, IIS issues the standard 404 error. |
This example demonstrates how to specify values declaratively for several attributes of the customErrors section, which can also be accessed as members of the CustomError class.
The following configuration file example shows how to specify values declaratively for the customErrors section.
<customErrors mode="RemoteOnly"
defaultRedirect="customerror.htm">
<error statusCode="404" redirect="customerror404.htm"/>
</customErrors>
The following code example demonstrates how to use the CustomError class.
Available since 2.0
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.