433 lines
22 KiB
XML
433 lines
22 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<Type Name="CustomErrorCollection" FullName="System.Web.Configuration.CustomErrorCollection">
|
||
<TypeSignature Language="C#" Value="public sealed class CustomErrorCollection : System.Configuration.ConfigurationElementCollection" />
|
||
<AssemblyInfo>
|
||
<AssemblyName>System.Web</AssemblyName>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<Base>
|
||
<BaseTypeName>System.Configuration.ConfigurationElementCollection</BaseTypeName>
|
||
</Base>
|
||
<Interfaces />
|
||
<Attributes>
|
||
<Attribute>
|
||
<AttributeName>System.Configuration.ConfigurationCollection(typeof(System.Web.Configuration.CustomError), AddItemName="error", CollectionType=System.Configuration.ConfigurationElementCollectionType.BasicMap)</AttributeName>
|
||
</Attribute>
|
||
</Attributes>
|
||
<Docs>
|
||
<since version=".NET 2.0" />
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="T:System.Web.Configuration.CustomErrorCollection" /> type allows access to the error elements of the customErrors section element collection.</para>
|
||
<para>It belongs to a group that includes the <see cref="T:System.Web.Configuration.CustomError" />, <see cref="T:System.Web.Configuration.CustomErrorsMode" />, and <see cref="T:System.Web.Configuration.CustomErrorsSection" />.</para>
|
||
<para> </para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Represents a collection of <see cref="T:System.Web.Configuration.CustomError" /> objects. This class cannot be inherited.</para>
|
||
</summary>
|
||
</Docs>
|
||
<Members>
|
||
<Member MemberName=".ctor">
|
||
<MemberSignature Language="C#" Value="public CustomErrorCollection ();" />
|
||
<MemberType>Constructor</MemberType>
|
||
<Parameters />
|
||
<Docs>
|
||
<since version=".NET 2.0" />
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="M:System.Web.Configuration.CustomErrorCollection.#ctor" /> constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the <see cref="T:System.Web.Configuration.CustomErrorCollection" /> class by using the <see cref="P:System.Web.Configuration.CustomErrorsSection.Errors" /> property.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Initializes a new instance of the <see cref="T:System.Web.Configuration.CustomErrorCollection" /> class.</para>
|
||
</summary>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="Add">
|
||
<MemberSignature Language="C#" Value="public void Add (System.Web.Configuration.CustomError customError);" />
|
||
<MemberType>Method</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Void</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="customError" Type="System.Web.Configuration.CustomError" />
|
||
</Parameters>
|
||
<Docs>
|
||
<since version=".NET 2.0" />
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Before adding a custom error to the collection, you must create a <see cref="T:System.Web.Configuration.CustomError" /> error object and initialize the <see cref="P:System.Web.Configuration.CustomError.Redirect" /> and <see cref="P:System.Web.Configuration.CustomError.StatusCode" /> properties.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Adds a <see cref="T:System.Web.Configuration.CustomError" /> object to the collection.</para>
|
||
</summary>
|
||
<param name="customError">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.Configuration.CustomError" /> object to add already exists in the collection or the collection is read only.</param>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="AllKeys">
|
||
<MemberSignature Language="C#" Value="public string[] AllKeys { get; }" />
|
||
<MemberType>Property</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.String[]</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Returns an array of the keys for all of the configuration elements contained in this <see cref="T:System.Web.Configuration.CustomErrorCollection" />.</para>
|
||
</summary>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="Clear">
|
||
<MemberSignature Language="C#" Value="public void Clear ();" />
|
||
<MemberType>Method</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Void</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<since version=".NET 2.0" />
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The result of updating the configuration file after calling the <see cref="M:System.Web.Configuration.CustomErrorCollection.Clear" /> method is dependent upon the <see cref="T:System.Configuration.ConfigurationSaveMode" /> chosen. To update the configuration file, you use one of these two overloads: <see cref="M:System.Configuration.Configuration.Save" /> and <see cref="M:System.Configuration.Configuration.Save(System.Configuration.ConfigurationSaveMode)" />.</para>
|
||
<block subset="none" type="note">
|
||
<para>Calling <see cref="M:System.Configuration.Configuration.Save" /> is equivalent to calling <see cref="M:System.Configuration.Configuration.Save(System.Configuration.ConfigurationSaveMode)" />.</para>
|
||
</block>
|
||
<para>If you use the <see cref="M:System.Configuration.Configuration.Save(System.Configuration.ConfigurationSaveMode)" />.method, the following conditions apply.</para>
|
||
<list type="bullet">
|
||
<item>
|
||
<para>If you pass a <see cref="F:System.Configuration.ConfigurationSaveMode.Full" /> or <see cref="F:System.Configuration.ConfigurationSaveMode.Modified" /> parameter value, then a clear element is inserted into the clientTarget section of the configuration file at the current hierarchy level. </para>
|
||
</item>
|
||
<item>
|
||
<para>If you pass the <see cref="F:System.Configuration.ConfigurationSaveMode.Minimal" /> parameter value, a series of remove elements are added to the <format type="text/html"><a href="17a0fa6e-a065-49cc-b900-ef73eda6a922">clientTarget Element (ASP.NET Settings Schema)</a></format> of the configuration file at the current hierarchy level. Each removes all references to an add element defined in a parent configuration file at a higher level in the hierarchy. When you use <see cref="F:System.Configuration.ConfigurationSaveMode.Minimal" />, there is one additional property on the collection that affects what gets serialized to the configuration file: <see cref="P:System.Configuration.ConfigurationElementCollection.EmitClear" />, which is false by default. The following conditions apply.</para>
|
||
<list type="bullet">
|
||
<item>
|
||
<para>If the <see cref="P:System.Configuration.ConfigurationElementCollection.EmitClear" /> set to true, clear element is inserted into the clientTarget section of the configuration file at the current hierarchy level. This removes all references to the add elements defined in the parent configuration files at higher levels in the hierarchy. </para>
|
||
</item>
|
||
<item>
|
||
<para>If the <see cref="P:System.Configuration.ConfigurationElementCollection.EmitClear" /> flag is set to false, the clear element is removed from the clientTarget section of the configuration file at the current hierarchy level, if it exists.</para>
|
||
</item>
|
||
</list>
|
||
</item>
|
||
</list>
|
||
<para>The <see cref="M:System.Web.Configuration.CustomErrorCollection.Clear" /> method actually deletes the add elements defined in the clientTarget section of the configuration file at the current hierarchy level. It also removes all references to the add elements defined in the parent configuration files at higher levels in the hierarchy.</para>
|
||
<block subset="none" type="note">
|
||
<para>The add elements are not deleted from the clientTarget section of the parent configuration files. </para>
|
||
</block>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Removes all <see cref="T:System.Web.Configuration.CustomError" /> objects from the collection.</para>
|
||
</summary>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="CollectionType">
|
||
<MemberSignature Language="C#" Value="public override System.Configuration.ConfigurationElementCollectionType CollectionType { get; }" />
|
||
<MemberType>Property</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Configuration.ConfigurationElementCollectionType</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The type of the <see cref="T:System.Web.Configuration.CustomErrorCollection" />.</para>
|
||
</summary>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="CreateNewElement">
|
||
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationElement CreateNewElement ();" />
|
||
<MemberType>Method</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Configuration.ConfigurationElement</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="ElementName">
|
||
<MemberSignature Language="C#" Value="protected override string ElementName { get; }" />
|
||
<MemberType>Property</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.String</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<summary>To be added.</summary>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="Get">
|
||
<MemberSignature Language="C#" Value="public System.Web.Configuration.CustomError Get (int index);" />
|
||
<MemberType>Method</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Web.Configuration.CustomError</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="index" Type="System.Int32" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets the <see cref="T:System.Web.Configuration.CustomError" /> object with the specified index.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="T:System.Web.Configuration.CustomError" /> with the specified index.</para>
|
||
</returns>
|
||
<param name="index">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The collection index of the <see cref="T:System.Web.Configuration.CustomError" /> object. </param>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="Get">
|
||
<MemberSignature Language="C#" Value="public System.Web.Configuration.CustomError Get (string statusCode);" />
|
||
<MemberType>Method</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Web.Configuration.CustomError</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="statusCode" Type="System.String" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets the <see cref="T:System.Web.Configuration.CustomError" /> object with the specified status code.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="T:System.Web.Configuration.CustomError" /> object with the specified status code.</para>
|
||
</returns>
|
||
<param name="statusCode">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The HTTP status code associated with the custom error. </param>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="GetElementKey">
|
||
<MemberSignature Language="C#" Value="protected override object GetElementKey (System.Configuration.ConfigurationElement element);" />
|
||
<MemberType>Method</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Object</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="element" Type="System.Configuration.ConfigurationElement" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="element">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="GetKey">
|
||
<MemberSignature Language="C#" Value="public string GetKey (int index);" />
|
||
<MemberType>Method</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.String</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="index" Type="System.Int32" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets the <see cref="T:System.Web.Configuration.CustomErrorCollection" /> key at the specified index.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="T:System.Web.Configuration.CustomErrorCollection" /> key at the specified index.</para>
|
||
</returns>
|
||
<param name="index">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The collection key's index. </param>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="Item">
|
||
<MemberSignature Language="C#" Value="public System.Web.Configuration.CustomError this[int index] { set; get; }" />
|
||
<MemberType>Property</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Web.Configuration.CustomError</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="index" Type="System.Int32" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="index">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="Item">
|
||
<MemberSignature Language="C#" Value="public System.Web.Configuration.CustomError this[string statusCode] { get; }" />
|
||
<MemberType>Property</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Web.Configuration.CustomError</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="statusCode" Type="System.String" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="statusCode">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="Properties">
|
||
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationPropertyCollection Properties { get; }" />
|
||
<MemberType>Property</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Configuration.ConfigurationPropertyCollection</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<summary>To be added.</summary>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="Remove">
|
||
<MemberSignature Language="C#" Value="public void Remove (string statusCode);" />
|
||
<MemberType>Method</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Void</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="statusCode" Type="System.String" />
|
||
</Parameters>
|
||
<Docs>
|
||
<since version=".NET 2.0" />
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="M:System.Web.Configuration.CustomErrorCollection.Remove(System.String)" /> method inserts a remove element into the customErrors section of the configuration file at the current hierarchy level. This removes the reference to the add element defined in the parent configuration files at higher levels in the hierarchy. </para>
|
||
<block subset="none" type="note">
|
||
<para>The add elements are not deleted from the parent configuration files. The remove element merely deactivates them. However, the <see cref="M:System.Web.Configuration.CustomErrorCollection.Remove(System.String)" /> method does actually delete them at the current hierarchy level.</para>
|
||
</block>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Removes a <see cref="T:System.Web.Configuration.CustomError" /> object from the collection.</para>
|
||
</summary>
|
||
<param name="statusCode">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The HTTP status code associated with the custom error. </param>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="RemoveAt">
|
||
<MemberSignature Language="C#" Value="public void RemoveAt (int index);" />
|
||
<MemberType>Method</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Void</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="index" Type="System.Int32" />
|
||
</Parameters>
|
||
<Docs>
|
||
<since version=".NET 2.0" />
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="M:System.Web.Configuration.CustomErrorCollection.RemoveAt(System.Int32)" /> method inserts a remove element into the customErrors section of the configuration file at the current hierarchy level. This is to remove the reference to the add element defined in the parent configuration files at higher-level in the hierarchy. </para>
|
||
<para>Note The add elements are not deleted from the parent configuration files. They are merely deactivated. However, the <see cref="M:System.Web.Configuration.CustomErrorCollection.RemoveAt(System.Int32)" /> method does actually delete them at the current hierarchy level.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Removes a <see cref="T:System.Web.Configuration.CustomError" /> object at the specified index location from the collection.</para>
|
||
</summary>
|
||
<param name="index">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The collection index of the <see cref="T:System.Web.Configuration.CustomError" /> object to remove. </param>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="Set">
|
||
<MemberSignature Language="C#" Value="public void Set (System.Web.Configuration.CustomError customError);" />
|
||
<MemberType>Method</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Void</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="customError" Type="System.Web.Configuration.CustomError" />
|
||
</Parameters>
|
||
<Docs>
|
||
<since version=".NET 2.0" />
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>This specified error replaces the current configuration error element.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Adds the specified <see cref="T:System.Web.Configuration.CustomError" /> to the collection.</para>
|
||
</summary>
|
||
<param name="customError">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.Configuration.CustomError" /> to add to the collection. </param>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
</Members>
|
||
</Type> |