Type: System.CodeDom.CodeIterationStatement

System.CodeDom.CodeIterationStatement Class

Assembly: System.dll
Namespace: System.CodeDom

Summary: Represents a for statement, or a simple loop through a block of statements, using a test expression as a condition for continuing to loop.

C# Syntax:

[Serializable]
public class CodeIterationStatement : CodeStatement

Remarks

CodeIterationStatement can be used to represent code that indicates a for loop or a while loop.

See also:

System.CodeDom Namespace

System.CodeDom.CodeIterationStatement Member List:

Public Constructors

ctor #1	Overloaded: `.ctor()`Default constructor. This constructor is called by derived class constructors to initialize state in this type. Initializes a new instance of the CodeIterationStatement class.
ctor #2	Overloaded: `.ctor(CodeStatement initStatement, CodeExpression testExpression, CodeStatement incrementStatement, params CodeStatement[] statements)` Initializes a new instance of the CodeIterationStatement class using the specified parameters.

Public Properties

IncrementStatement	Read-write Gets or sets the statement that is called after each loop cycle.
InitStatement	Read-write Gets or sets the loop initialization statement.
LinePragma (inherited from System.CodeDom.CodeStatement)	Read-write See base class member description: System.CodeDom.CodeStatement.LinePragma Gets or sets the line the statement occurs on.
Statements	Read-only Gets the collection of statements to be executed within the loop.
TestExpression	Read-write Gets or sets the expression to test as the condition that continues the loop.
UserData (inherited from System.CodeDom.CodeObject)	Read-only See base class member description: System.CodeDom.CodeObject.UserData Gets or sets the user-definable data for the current object.

Public Methods

Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetHashCode (inherited from System.Object)	See base class member description: System.Object.GetHashCode Derived from System.Object, the primary base class for all objects.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

System.Object

System.CodeDom.CodeObject

System.CodeDom.CodeStatement

System.CodeDom.CodeIterationStatement

System.CodeDom.CodeIterationStatement Member Details

Overloaded ctor #1

Summary: Initializes a new instance of the CodeIterationStatement class.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:


            public CodeIterationStatement();

Return to top

Overloaded ctor #2

Summary: Initializes a new instance of the CodeIterationStatement class using the specified parameters.

C# Syntax:


            public CodeIterationStatement(
   CodeStatement initStatement,
   CodeExpression testExpression,
   CodeStatement incrementStatement,
   params CodeStatement[] statements
);

Parameters:

initStatement

A CodeStatement containing the loop initialization statement.

testExpression

A CodeExpression containing the expression to test for exit condition.

incrementStatement

A CodeStatement containing the per-cycle increment statement.

statements

An array of type CodeStatement containing the statements within the loop.

See also:
CodeStatement | CodeExpression

Return to top

Property: IncrementStatement (read-write)

Summary: Gets or sets the statement that is called after each loop cycle.

C# Syntax:


            public CodeStatement IncrementStatement {get; set;}

Remarks

This statement is called after each iteration.

See also:
CodeStatement

Return to top

Property: InitStatement (read-write)

Summary: Gets or sets the loop initialization statement.

C# Syntax:


            public CodeStatement InitStatement {get; set;}

Return to top

Property: LinePragma (read-write)

Inherited
See base class member description: System.CodeDom.CodeStatement.LinePragma

Summary: Gets or sets the line the statement occurs on.

C# Syntax:


            public CodeLinePragma LinePragma {get; set;}

Remarks

This property indicates the location of the statement.

See also:
CodeLinePragma

Return to top

Property: Statements (read-only)

Summary: Gets the collection of statements to be executed within the loop.

C# Syntax:


            public CodeStatementCollection Statements {get;}

See also:
CodeStatement

Return to top

Property: TestExpression (read-write)

Summary: Gets or sets the expression to test as the condition that continues the loop.

C# Syntax:


            public CodeExpression TestExpression {get; set;}

Remarks

If this expression resolves to true, the loop will continue.

See also:
CodeExpression

Return to top

Property: UserData (read-only)

Inherited
See base class member description: System.CodeDom.CodeObject.UserData

Summary: Gets or sets the user-definable data for the current object.

C# Syntax:


            public IDictionary UserData {get;}

Remarks

Notes to inheritors: An inheritor can design the way this user data is stored, retrieved, and used.

Return to top

Method: Equals(
object obj
)

Inherited
See base class member description: System.Object.Equals

C# Syntax:


            public virtual bool Equals(
   object obj
);