This documentation is archived and is not being maintained.

CodeThrowExceptionStatement Class

Represents a statement that throws an exception.


Namespace:  System.CodeDom
Assembly:  System (in System.dll)

public class CodeThrowExceptionStatement : CodeStatement

The CodeThrowExceptionStatement type exposes the following members.

Public methodCodeThrowExceptionStatement()Initializes a new instance of the CodeThrowExceptionStatement class.
Public methodCodeThrowExceptionStatement(CodeExpression)Initializes a new instance of the CodeThrowExceptionStatement class with the specified exception type instance.

Public propertyEndDirectivesGets a CodeDirectiveCollection object that contains end directives. (Inherited from CodeStatement.)
Public propertyLinePragmaGets or sets the line on which the code statement occurs. (Inherited from CodeStatement.)
Public propertyStartDirectivesGets a CodeDirectiveCollection object that contains start directives. (Inherited from CodeStatement.)
Public propertyToThrowGets or sets the exception to throw.
Public propertyUserDataGets the user-definable data for the current object. (Inherited from CodeObject.)

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

CodeThrowExceptionStatement can represent a statement that throws an exception. The expression should be, or evaluate to, a reference to an instance of a type that derives from the Exception class.

The ToThrow property specifies the exception to throw.

This example demonstrates using a CodeThrowExceptionStatement to throw a new System.Exception.

// This CodeThrowExceptionStatement throws a new System.Exception.
CodeThrowExceptionStatement throwException = new CodeThrowExceptionStatement( 
    // codeExpression parameter indicates the exception to throw.
    // You must use an object create expression to new an exception here.
    new CodeObjectCreateExpression(
    // createType parameter inidicates the type of object to create.
    new CodeTypeReference(typeof(System.Exception)),
    // parameters parameter indicates the constructor parameters.
    new CodeExpression[] {} ) );

// A C# code generator produces the following source code for the preceeding example code:

// throw new System.Exception();

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.