CodeStatementCollection Class

Definition

Namespace:

System.CodeDom

Assembly:

System.CodeDom.dll

Represents a collection of CodeStatement objects.

public ref class CodeStatementCollection : System::Collections::CollectionBase

public class CodeStatementCollection : System.Collections.CollectionBase

type CodeStatementCollection = class
    inherit CollectionBase

Public Class CodeStatementCollection
Inherits CollectionBase

Inheritance

Object

CollectionBase

CodeStatementCollection

Examples

The following example demonstrates how to use the CodeStatementCollection class. The example creates a new instance of the class and uses several methods to add statements to the collection, return their index, and add or remove statements at a specific index point.

// Creates an empty CodeStatementCollection.
CodeStatementCollection^ collection = gcnew CodeStatementCollection;

// Adds a CodeStatement to the collection.
collection->Add( gcnew CodeCommentStatement( "Test comment statement" ) );

// Adds an array of CodeStatement objects to the collection.
array<CodeStatement^>^statements = {gcnew CodeCommentStatement( "Test comment statement" ),gcnew CodeCommentStatement( "Test comment statement" )};
collection->AddRange( statements );

// Adds a collection of CodeStatement objects to the collection.
CodeStatement^ testStatement = gcnew CodeCommentStatement( "Test comment statement" );
CodeStatementCollection^ statementsCollection = gcnew CodeStatementCollection;
statementsCollection->Add( gcnew CodeCommentStatement( "Test comment statement" ) );
statementsCollection->Add( gcnew CodeCommentStatement( "Test comment statement" ) );
statementsCollection->Add( testStatement );
collection->AddRange( statementsCollection );

// Tests for the presence of a CodeStatement in the 
// collection, and retrieves its index if it is found.
int itemIndex = -1;
if ( collection->Contains( testStatement ) )
   itemIndex = collection->IndexOf( testStatement );

// Copies the contents of the collection beginning at index 0 to the specified CodeStatement array.
// 'statements' is a CodeStatement array.
collection->CopyTo( statements, 0 );

// Retrieves the count of the items in the collection.
int collectionCount = collection->Count;

// Inserts a CodeStatement at index 0 of the collection.
collection->Insert( 0, gcnew CodeCommentStatement( "Test comment statement" ) );

// Removes the specified CodeStatement from the collection.
collection->Remove( testStatement );

// Removes the CodeStatement at index 0.
collection->RemoveAt( 0 );

// Creates an empty CodeStatementCollection.
CodeStatementCollection collection = new CodeStatementCollection();

// Adds a CodeStatement to the collection.
collection.Add( new CodeCommentStatement("Test comment statement") );

// Adds an array of CodeStatement objects to the collection.
CodeStatement[] statements = {
                new CodeCommentStatement("Test comment statement"),
                new CodeCommentStatement("Test comment statement")};
collection.AddRange( statements );

// Adds a collection of CodeStatement objects to the collection.
CodeStatement testStatement = new CodeCommentStatement("Test comment statement");
CodeStatementCollection statementsCollection = new CodeStatementCollection();
statementsCollection.Add( new CodeCommentStatement("Test comment statement") );
statementsCollection.Add( new CodeCommentStatement("Test comment statement") );
statementsCollection.Add( testStatement );

collection.AddRange( statementsCollection );

// Tests for the presence of a CodeStatement in the
// collection, and retrieves its index if it is found.
int itemIndex = -1;
if( collection.Contains( testStatement ) )
    itemIndex = collection.IndexOf( testStatement );


// Copies the contents of the collection beginning at index 0 to the specified CodeStatement array.
// 'statements' is a CodeStatement array.
CodeStatement[] statementArray = new CodeStatement[collection.Count];
collection.CopyTo( statementArray, 0 );

// Retrieves the count of the items in the collection.
int collectionCount = collection.Count;

// Inserts a CodeStatement at index 0 of the collection.
collection.Insert( 0, new CodeCommentStatement("Test comment statement") );

// Removes the specified CodeStatement from the collection.
collection.Remove( testStatement );

// Removes the CodeStatement at index 0.
collection.RemoveAt(0);

' Creates an empty CodeStatementCollection.
Dim collection As New CodeStatementCollection

' Adds a CodeStatement to the collection.
collection.Add(New CodeCommentStatement("Test comment statement"))

' Adds an array of CodeStatement objects to the collection.
Dim statements As CodeStatement() = {New CodeCommentStatement("Test comment statement"), New CodeCommentStatement("Test comment statement")}
collection.AddRange(statements)

' Adds a collection of CodeStatement objects to the collection.
Dim testStatement As New CodeStatement
Dim statementsCollection As New CodeStatementCollection
statementsCollection.Add(New CodeCommentStatement("Test comment statement"))
statementsCollection.Add(New CodeCommentStatement("Test comment statement"))
statementsCollection.Add(testStatement)
collection.AddRange(statementsCollection)

' Tests for the presence of a CodeStatement in the 
' collection, and retrieves its index if it is found.
Dim itemIndex As Integer = -1
If collection.Contains(testStatement) Then
    itemIndex = collection.IndexOf(testStatement)
End If

' Copies the contents of the collection beginning at index 0 to the specified CodeStatement array.
' 'statements' is a CodeStatement array.
Dim statementArray(collection.Count - 1) As CodeStatement
collection.CopyTo(statementArray, 0)

' Retrieves the count of the items in the collection.
Dim collectionCount As Integer = collection.Count

' Inserts a CodeStatement at index 0 of the collection.
collection.Insert(0, New CodeCommentStatement("Test comment statement"))

' Removes the specified CodeStatement from the collection.
collection.Remove(testStatement)

' Removes the CodeStatement at index 0.
collection.RemoveAt(0)

Remarks

The CodeStatementCollection class provides a simple collection object that can be used to store a set of CodeStatement objects.

Constructors

CodeStatementCollection()	Initializes a new instance of the CodeStatementCollection class.
CodeStatementCollection(CodeStatement[])	Initializes a new instance of the CodeStatementCollection class that contains the specified array of CodeStatement objects.
CodeStatementCollection(CodeStatementCollection)	Initializes a new instance of the CodeStatementCollection class that contains the elements of the specified source collection.

Properties

Capacity	Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase)
Count	Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase)
InnerList	Gets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase)
Item[Int32]	Gets or sets the CodeStatement object at the specified index in the collection.
List	Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase)

Methods

Add(CodeExpression)	Adds the specified CodeExpression object to the collection.
Add(CodeStatement)	Adds the specified CodeStatement object to the collection.
AddRange(CodeStatement[])	Adds a set of CodeStatement objects to the collection.
AddRange(CodeStatementCollection)	Adds the contents of another CodeStatementCollection object to the end of the collection.
Clear()	Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase)
Contains(CodeStatement)	Gets a value that indicates whether the collection contains the specified CodeStatement object.
CopyTo(CodeStatement[], Int32)	Copies the elements of the CodeStatementCollection object to a one-dimensional Array instance, starting at the specified index.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator()	Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IndexOf(CodeStatement)	Gets the index of the specified CodeStatement object in the CodeStatementCollection, if it exists in the collection.
Insert(Int32, CodeStatement)	Inserts the specified CodeStatement object into the collection at the specified index.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnClear()	Performs additional custom processes when clearing the contents of the CollectionBase instance. (Inherited from CollectionBase)
OnClearComplete()	Performs additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase)
OnInsert(Int32, Object)	Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase)
OnInsertComplete(Int32, Object)	Performs additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase)
OnRemove(Int32, Object)	Performs additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase)
OnRemoveComplete(Int32, Object)	Performs additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase)
OnSet(Int32, Object, Object)	Performs additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase)
OnSetComplete(Int32, Object, Object)	Performs additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase)
OnValidate(Object)	Performs additional custom processes when validating a value. (Inherited from CollectionBase)
Remove(CodeStatement)	Removes the specified CodeStatement object from the collection.
RemoveAt(Int32)	Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

See also

• CodeStatement