Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

HttpParseException Class

.NET Framework 4

The exception that is thrown when a parse error occurs.

System.Object
  System.Exception
    System.SystemException
      System.Runtime.InteropServices.ExternalException
        System.Web.HttpException
          System.Web.HttpParseException

Namespace:  System.Web
Assembly:  System.Web (in System.Web.dll)
C#
C++
F#
VB
Copy 
[SerializableAttribute]
public sealed class HttpParseException : HttpException

The HttpParseException type exposes the following members.

  Name Description
Public method HttpParseException() Initializes a new instance of the HttpParseException class.
Public method HttpParseException(String) Initializes a new instance of the HttpParseException class with a specified error message.
Public method HttpParseException(String, Exception) Initializes a new instance of the HttpParseException class with a specified error message and a reference to the inner.
Public method HttpParseException(String, Exception, String, String, Int32) Initializes a new instance of the HttpParseException class with specific information about the source code being compiled and the line number on which the exception occurred.
Top
  Name Description
Public property Data Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public property ErrorCode Gets the HRESULT of the error. (Inherited from ExternalException.)
Public property FileName Gets the name of the file being parsed when the error occurs.
Public property HelpLink Gets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Protected property HResult Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public property InnerException Gets the Exception instance that caused the current exception. (Inherited from Exception.)
Public property Line Gets the number of the line being parsed when the error occurs.
Public property Message Gets a message that describes the current exception. (Inherited from Exception.)
Public property ParserErrors Gets the parser errors for the current exception.
Public property Source Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public property StackTrace Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public property TargetSite Gets the method that throws the current exception. (Inherited from Exception.)
Public property VirtualPath Gets the virtual path to source file that generated the error.
Public property WebEventCode Gets the event codes that are associated with the HTTP exception. (Inherited from HttpException.)
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetBaseException When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetHtmlErrorMessage Gets the HTML error message to return to the client. (Inherited from HttpException.)
Public method GetHttpCode Gets the HTTP response status code to return to the client. (Inherited from HttpException.)
Public method GetObjectData When overridden in a derived class, sets the SerializationInfo object with information about the exception. (Overrides HttpException.GetObjectData(SerializationInfo, StreamingContext).)
Public method GetType Gets the runtime type of the current instance. (Inherited from Exception.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that contains the HRESULT of the error. (Inherited from ExternalException.)
Top
  Name Description
Protected event SerializeObjectState Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.)
Top

The HttpParseException class is an HTTP-specific exception class that enables ASP.NET to output parser exception information. For more information on throwing and handling exceptions, see Handling and Throwing Exceptions.

The following example demonstrates how to use the HttpParseException to customize errors generated during page parsing. In this example, a customized HtmlSelect control is defined. If child elements of the custom control are not of a specified type then an HttpParseException is thrown in the overridden GetChildControlType method of a custom HtmlSelectBuilder. To generate a parse exception, change the child element literal MyCustomOption to any other string.

C#
VB
Copy 

<%@ Page Language="C#"%>
<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.CS" Assembly="Samples.AspNet.CS" %>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>HttpParseException Example</title>
</head>
  <body>
    <form id="Form1" runat="server">
      <h3>HttpParseException Example</h3>

      <aspSample:CustomHtmlSelectWithHttpParseException
       id="customhtmlselect1"
       runat="server">
      <aspSample:MyCustomOption optionid="option1" value="1"/>
      <aspSample:MyCustomOption optionid="option2" value="2"/>
      <aspSample:MyCustomOption optionid="option3" value="3"/>
      </aspSample:CustomHtmlSelectWithHttpParseException>

    </form>

  </body>

</html>
C#
VB
Copy 

using System;
using System.Security.Permissions;
using System.Collections;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.HtmlControls;

namespace Samples.AspNet.CS
{
    // Define a child control for the custom HtmlSelect.
    public class MyCustomOption
    {
        string _id;
        string _value;

        public string optionid
        {
            get
            { return _id; }
            set
            { _id = value; }
        }

        public string value
        {
            get
            { return _value; }
            set
            { _value = value; }
        }

    }

    // Define a custom HtmlSelectBuilder.
    public class MyHtmlSelectBuilderWithparseException : HtmlSelectBuilder
    {
        [AspNetHostingPermission(SecurityAction.Demand, Level = AspNetHostingPermissionLevel.Minimal)]
        public override Type GetChildControlType(string tagName, IDictionary attribs)
        {
            // Distinguish between two possible types of child controls.
            if (tagName.ToLower().EndsWith("mycustomoption"))
            {
                return typeof(MyCustomOption);
            }
            else
            {
                throw new HttpParseException("This custom HtmlSelect control" +                                                  "requires child elements of the form \"MyCustomOption\"");
            }
        }

    }

    [ControlBuilderAttribute(typeof(MyHtmlSelectBuilderWithparseException))]
    public class CustomHtmlSelectWithHttpParseException : HtmlSelect
    {
        // Override the AddParsedSubObject method.
        protected override void AddParsedSubObject(object obj)
        {

            string _outputtext;
            if (obj is MyCustomOption)
            {
                _outputtext = "custom select option : " + ((MyCustomOption)obj).value;
                ListItem li = new ListItem(_outputtext, ((MyCustomOption)obj).value);
                base.Items.Add(li);
            }
        }      
    }

}

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ