CustomErrorCollection Class

Definition

Represents a collection of CustomError objects. This class cannot be inherited.

public ref class CustomErrorCollection sealed : System::Configuration::ConfigurationElementCollection
[System.Configuration.ConfigurationCollection(typeof(System.Web.Configuration.CustomError), AddItemName="error", CollectionType=System.Configuration.ConfigurationElementCollectionType.BasicMap)]
public sealed class CustomErrorCollection : System.Configuration.ConfigurationElementCollection
[<System.Configuration.ConfigurationCollection(typeof(System.Web.Configuration.CustomError), AddItemName="error", CollectionType=System.Configuration.ConfigurationElementCollectionType.BasicMap)>]
type CustomErrorCollection = class
    inherit ConfigurationElementCollection
Public NotInheritable Class CustomErrorCollection
Inherits ConfigurationElementCollection
Inheritance
Attributes

Examples

This example demonstrates how to specify values declaratively for the error elements of the customErrors section, which can also be accessed as elements of the CustomErrorCollection collection.

The following configuration file example shows how to specify values declaratively for the error elements.

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

The following code example demonstrates how to use the CustomErrorCollection class.


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

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

// Get the collection
CustomErrorCollection customErrorsCollection = 
    customErrorsSection.Errors;
      ' Get the Web application configuration.
        Dim configuration _
        As System.Configuration.Configuration = _
WebConfigurationManager.OpenWebConfiguration( _
        "/aspnetTest")
      
      ' Get the section.
        Dim customErrorsSection _
        As CustomErrorsSection = _
        CType(configuration.GetSection( _
  "system.web/customErrors"), _
  CustomErrorsSection)
      
      ' Get the collection
        Dim customErrorsCollection _
        As CustomErrorCollection = customErrorsSection.Errors

Remarks

The CustomErrorCollection type allows access to the error elements of the customErrors section element collection.

It belongs to a group that includes the CustomError, CustomErrorsMode, and CustomErrorsSection.

Constructors

CustomErrorCollection()

Initializes a new instance of the CustomErrorCollection class.

Properties

AddElementName

Gets or sets the name of the ConfigurationElement to associate with the add operation in the ConfigurationElementCollection when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
AllKeys

Returns an array of the keys for all of the configuration elements contained in this CustomErrorCollection.

ClearElementName

Gets or sets the name for the ConfigurationElement to associate with the clear operation in the ConfigurationElementCollection when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
CollectionType

The type of the CustomErrorCollection.

Count

Gets the number of elements in the collection.

(Inherited from ConfigurationElementCollection)
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)
ElementName

Gets the name used to identify this collection of elements in the configuration file when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
ElementProperty

Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.

(Inherited from ConfigurationElement)
EmitClear

Gets or sets a value that specifies whether the collection has been cleared.

(Inherited from ConfigurationElementCollection)
EvaluationContext

Gets the ContextInformation object for the ConfigurationElement object.

(Inherited from ConfigurationElement)
HasContext

Gets a value that indicates whether the CurrentConfiguration property is null.

(Inherited from ConfigurationElement)
IsSynchronized

Gets a value indicating whether access to the collection is synchronized.

(Inherited from ConfigurationElementCollection)
Item[ConfigurationProperty]

Gets or sets a property or attribute of this configuration element.

(Inherited from ConfigurationElement)
Item[Int32]

Gets the CustomError with the specified index.

Item[String]

Gets the CustomError with the specified status code.

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)
RemoveElementName

Gets or sets the name of the ConfigurationElement to associate with the remove operation in the ConfigurationElementCollection when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
SyncRoot

Gets an object used to synchronize access to the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
ThrowOnDuplicate

Gets a value indicating whether an attempt to add a duplicate ConfigurationElement to the ConfigurationElementCollection will cause an exception to be thrown.

(Inherited from ConfigurationElementCollection)

Methods

Add(CustomError)

Adds a CustomError object to the collection.

BaseAdd(ConfigurationElement)

Adds a configuration element to the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
BaseAdd(ConfigurationElement, Boolean)

Adds a configuration element to the configuration element collection.

(Inherited from ConfigurationElementCollection)
BaseAdd(Int32, ConfigurationElement)

Adds a configuration element to the configuration element collection.

(Inherited from ConfigurationElementCollection)
BaseClear()

Removes all configuration element objects from the collection.

(Inherited from ConfigurationElementCollection)
BaseGet(Int32)

Gets the configuration element at the specified index location.

(Inherited from ConfigurationElementCollection)
BaseGet(Object)

Returns the configuration element with the specified key.

(Inherited from ConfigurationElementCollection)
BaseGetAllKeys()

Returns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
BaseGetKey(Int32)

Gets the key for the ConfigurationElement at the specified index location.

(Inherited from ConfigurationElementCollection)
BaseIndexOf(ConfigurationElement)

Indicates the index of the specified ConfigurationElement.

(Inherited from ConfigurationElementCollection)
BaseIsRemoved(Object)

Indicates whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
BaseRemove(Object)

Removes a ConfigurationElement from the collection.

(Inherited from ConfigurationElementCollection)
BaseRemoveAt(Int32)

Removes the ConfigurationElement at the specified index location.

(Inherited from ConfigurationElementCollection)
Clear()

Removes all CustomError objects from the collection.

CopyTo(ConfigurationElement[], Int32)

Copies the contents of the ConfigurationElementCollection to an array.

(Inherited from ConfigurationElementCollection)
CreateNewElement()

When overridden in a derived class, creates a new ConfigurationElement.

(Inherited from ConfigurationElementCollection)
CreateNewElement(String)

Creates a new ConfigurationElement when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
DeserializeElement(XmlReader, Boolean)

Reads XML from the configuration file.

(Inherited from ConfigurationElement)
Equals(Object)

Compares the ConfigurationElementCollection to the specified object.

(Inherited from ConfigurationElementCollection)
Get(Int32)

Gets the CustomError object with the specified index.

Get(String)

Gets the CustomError object with the specified status code.

GetElementKey(ConfigurationElement)

Gets the element key for a specified configuration element when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
GetEnumerator()

Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
GetHashCode()

Gets a unique value representing the ConfigurationElementCollection instance.

(Inherited from ConfigurationElementCollection)
GetKey(Int32)

Gets the CustomErrorCollection key at the specified index.

GetTransformedAssemblyString(String)

Returns the transformed version of the specified assembly name.

(Inherited from ConfigurationElement)
GetTransformedTypeString(String)

Returns the transformed version of the specified type name.

(Inherited from ConfigurationElement)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
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)
IsElementName(String)

Indicates whether the specified ConfigurationElement exists in the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
IsElementRemovable(ConfigurationElement)

Indicates whether the specified ConfigurationElement can be removed from the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
IsModified()

Indicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
IsReadOnly()

Indicates whether the ConfigurationElementCollection object is read only.

(Inherited from ConfigurationElementCollection)
ListErrors(IList)

Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.

(Inherited from ConfigurationElement)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String)

Gets a value indicating whether an unknown attribute is encountered during deserialization.

(Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

Causes the configuration system to throw an exception.

(Inherited from ConfigurationElementCollection)
OnRequiredPropertyNotFound(String)

Throws an exception when a required property is not found.

(Inherited from ConfigurationElement)
PostDeserialize()

Called after deserialization.

(Inherited from ConfigurationElement)
PreSerialize(XmlWriter)

Called before serialization.

(Inherited from ConfigurationElement)
Remove(String)

Removes a CustomError object from the collection.

RemoveAt(Int32)

Removes a CustomError object at the specified index location from the collection.

Reset(ConfigurationElement)

Resets the ConfigurationElementCollection to its unmodified state when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
ResetModified()

Resets the value of the IsModified() property to false when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
SerializeElement(XmlWriter, Boolean)

Writes the configuration data to an XML element in the configuration file when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
SerializeToXmlElement(XmlWriter, String)

Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.

(Inherited from ConfigurationElement)
Set(CustomError)

Adds the specified CustomError to the collection.

SetPropertyValue(ConfigurationProperty, Object, Boolean)

Sets a property to the specified value.

(Inherited from ConfigurationElement)
SetReadOnly()

Sets the IsReadOnly() property for the ConfigurationElementCollection object and for all sub-elements.

(Inherited from ConfigurationElementCollection)
ToString()

Returns a string that represents the current object.

(Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

Reverses the effect of merging configuration information from different levels of the configuration hierarchy.

(Inherited from ConfigurationElementCollection)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

Copies the ConfigurationElementCollection to an array.

(Inherited from ConfigurationElementCollection)

Extension Methods

Cast<TResult>(IEnumerable)

Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable)

Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable)

Enables parallelization of a query.

AsQueryable(IEnumerable)

Converts an IEnumerable to an IQueryable.

Applies to

See also