This topic has not yet been rated - Rate this topic

CodeTryCatchFinallyStatement Class

Represents a try block with any number of catch clauses and, optionally, a finally block.

System.Object
  System.CodeDom.CodeObject
    System.CodeDom.CodeStatement
      System.CodeDom.CodeTryCatchFinallyStatement

Namespace:  System.CodeDom
Assembly:  System (in System.dll)
[SerializableAttribute]
[ComVisibleAttribute(true)]
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
public class CodeTryCatchFinallyStatement : CodeStatement

The CodeTryCatchFinallyStatement type exposes the following members.

  Name Description
Public method CodeTryCatchFinallyStatement() Initializes a new instance of the CodeTryCatchFinallyStatement class.
Public method CodeTryCatchFinallyStatement(CodeStatement[], CodeCatchClause[]) Initializes a new instance of the CodeTryCatchFinallyStatement class using the specified statements for try and catch clauses.
Public method CodeTryCatchFinallyStatement(CodeStatement[], CodeCatchClause[], CodeStatement[]) Initializes a new instance of the CodeTryCatchFinallyStatement class using the specified statements for try, catch clauses, and finally statements.
Top
  Name Description
Public property CatchClauses Gets the catch clauses to use.
Public property EndDirectives Gets a CodeDirectiveCollection object that contains end directives. (Inherited from CodeStatement.)
Public property FinallyStatements Gets the finally statements to use.
Public property LinePragma Gets or sets the line on which the code statement occurs. (Inherited from CodeStatement.)
Public property StartDirectives Gets a CodeDirectiveCollection object that contains start directives. (Inherited from CodeStatement.)
Public property TryStatements Gets the statements to try.
Public property UserData Gets the user-definable data for the current object. (Inherited from CodeObject.)
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 GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

CodeTryCatchFinallyStatement can be used to represent a try/ catch block of code.

The TryStatements property contains the statements to execute within a try block. The CatchClauses property contains the catch clauses to handle caught exceptions. The FinallyStatements property contains the statements to execute within a finally block.

Note Note

Not all languages support try/catch blocks. Call the Supports method with the GeneratorSupport.TryCatchStatements flag to determine whether a code generator supports try/catch blocks.

The following example code demonstrates use of a CodeTryCatchFinallyStatement to define a try...catch...finally statement for exception handling.


            // Declares a type to contain a try...catch block.
            CodeTypeDeclaration type1 = new CodeTypeDeclaration("TryCatchTest");

            // Defines a method that throws an exception of type System.ApplicationException.
            CodeMemberMethod method1 = new CodeMemberMethod();
            method1.Name = "ThrowApplicationException";
            method1.Statements.Add( new CodeThrowExceptionStatement( 
                new CodeObjectCreateExpression("System.ApplicationException", new CodePrimitiveExpression("Test Application Exception")) ) );
            type1.Members.Add( method1 );

            // Defines a constructor that calls the ThrowApplicationException method from a try block.
            CodeConstructor constructor1 = new CodeConstructor();
            constructor1.Attributes = MemberAttributes.Public;            
            type1.Members.Add( constructor1 );    

            // Defines a try statement that calls the ThrowApplicationException method.
            CodeTryCatchFinallyStatement try1 = new CodeTryCatchFinallyStatement();
            try1.TryStatements.Add( new CodeMethodInvokeExpression( new CodeThisReferenceExpression(), "ThrowApplicationException" ) );
            constructor1.Statements.Add( try1 );                    

            // Defines a catch clause for exceptions of type ApplicationException.
            CodeCatchClause catch1 = new CodeCatchClause("ex", new CodeTypeReference("System.ApplicationException"));
            catch1.Statements.Add( new CodeCommentStatement("Handle any System.ApplicationException here.") );
            try1.CatchClauses.Add( catch1 );

            // Defines a catch clause for any remaining unhandled exception types.
            CodeCatchClause catch2 = new CodeCatchClause("ex");
            catch2.Statements.Add( new CodeCommentStatement("Handle any other exception type here.") );
            try1.CatchClauses.Add( catch2 );

            // Defines a finally block by adding to the FinallyStatements collection.
            try1.FinallyStatements.Add( new CodeCommentStatement("Handle any finally block statements.") );

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

            //    public class TryCatchTest 
            //    {
            //        
            //        public TryCatchTest() 
            //        {
            //            try 
            //            {
            //                this.ThrowApplicationException();
            //            }
            //            catch (System.ApplicationException ex) 
            //            {
            //                // Handle any System.ApplicationException here.
            //            }
            //            catch (System.Exception ex) 
            //            {
            //                // Handle any other exception type here.
            //            }
            //          finally {
            //                // Handle any finally block statements.
            //            }
            //        }
            //        
            //        private void ThrowApplicationException() 
            //        {
            //            throw new System.ApplicationException("Test Application 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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ