CodeTypeDeclarationCollection Class

Definition

Namespace:

System.CodeDom

Assembly:

System.CodeDom.dll

Represents a collection of CodeTypeDeclaration objects.

public ref class CodeTypeDeclarationCollection : System::Collections::CollectionBase

public class CodeTypeDeclarationCollection : System.Collections.CollectionBase

type CodeTypeDeclarationCollection = class
    inherit CollectionBase

Public Class CodeTypeDeclarationCollection
Inherits CollectionBase

Inheritance

Object

CollectionBase

CodeTypeDeclarationCollection

Examples

The following example demonstrates how to use the CodeTypeDeclarationCollection 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 attributes at a specific index point.

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

// Adds a CodeTypeDeclaration to the collection.
collection->Add( gcnew CodeTypeDeclaration( "TestType" ) );

// Adds an array of CodeTypeDeclaration objects to the collection.
array<CodeTypeDeclaration^>^declarations = {gcnew CodeTypeDeclaration( "TestType1" ),gcnew CodeTypeDeclaration( "TestType2" )};
collection->AddRange( declarations );

// Adds a collection of CodeTypeDeclaration objects to the 
// collection.
CodeTypeDeclarationCollection^ declarationsCollection = gcnew CodeTypeDeclarationCollection;
declarationsCollection->Add( gcnew CodeTypeDeclaration( "TestType1" ) );
declarationsCollection->Add( gcnew CodeTypeDeclaration( "TestType2" ) );
collection->AddRange( declarationsCollection );

// Tests for the presence of a CodeTypeDeclaration in the 
// collection, and retrieves its index if it is found.
CodeTypeDeclaration^ testDeclaration = gcnew CodeTypeDeclaration( "TestType" );
int itemIndex = -1;
if ( collection->Contains( testDeclaration ) )
   itemIndex = collection->IndexOf( testDeclaration );

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

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

// Inserts a CodeTypeDeclaration at index 0 of the collection.
collection->Insert( 0, gcnew CodeTypeDeclaration( "TestType" ) );

// Removes the specified CodeTypeDeclaration from the collection.
CodeTypeDeclaration^ declaration = gcnew CodeTypeDeclaration( "TestType" );
collection->Remove( declaration );

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

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

// Adds a CodeTypeDeclaration to the collection.
collection.Add( new CodeTypeDeclaration("TestType") );

// Adds an array of CodeTypeDeclaration objects to the collection.
CodeTypeDeclaration[] declarations = { new CodeTypeDeclaration("TestType1"), new CodeTypeDeclaration("TestType2") };
collection.AddRange( declarations );

// Adds a collection of CodeTypeDeclaration objects to the
// collection.
CodeTypeDeclarationCollection declarationsCollection = new CodeTypeDeclarationCollection();
declarationsCollection.Add( new CodeTypeDeclaration("TestType1") );
declarationsCollection.Add( new CodeTypeDeclaration("TestType2") );
collection.AddRange( declarationsCollection );

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

// Copies the contents of the collection, beginning at index 0,
// to the specified CodeTypeDeclaration array.
// 'declarations' is a CodeTypeDeclaration array.
collection.CopyTo( declarations, 0 );

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

// Inserts a CodeTypeDeclaration at index 0 of the collection.
collection.Insert( 0, new CodeTypeDeclaration("TestType") );

// Removes the specified CodeTypeDeclaration from the collection.
CodeTypeDeclaration declaration = new CodeTypeDeclaration("TestType");
collection.Remove( declaration );

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

' Creates an empty CodeTypeDeclarationCollection.
Dim collection As New CodeTypeDeclarationCollection()

' Adds a CodeTypeDeclaration to the collection.
collection.Add(New CodeTypeDeclaration("TestType"))

' Adds an array of CodeTypeDeclaration objects to the 
' collection.
Dim declarations As CodeTypeDeclaration() = {New CodeTypeDeclaration("TestType1"), New CodeTypeDeclaration("TestType2")}
collection.AddRange(declarations)

' Adds a collection of CodeTypeDeclaration objects to the collection.
Dim declarationsCollection As New CodeTypeDeclarationCollection()
declarationsCollection.Add(New CodeTypeDeclaration("TestType1"))
declarationsCollection.Add(New CodeTypeDeclaration("TestType2"))
collection.AddRange(declarationsCollection)

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

' Copies the contents of the collection, beginning at index 0,
' to the specified CodeTypeDeclaration array.
' 'declarations' is a CodeTypeDeclaration array.
collection.CopyTo(declarations, 0)

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

' Inserts a CodeTypeDeclaration at index 0 of the collection.
collection.Insert(0, New CodeTypeDeclaration("TestType"))

' Removes the specified CodeTypeDeclaration from the collection.
Dim declaration As New CodeTypeDeclaration("TestType")
collection.Remove(declaration)

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

Remarks

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

Constructors

CodeTypeDeclarationCollection()	Initializes a new instance of the CodeTypeDeclarationCollection class.
CodeTypeDeclarationCollection(CodeTypeDeclaration[])	Initializes a new instance of the CodeTypeDeclarationCollection class that contains the specified array of CodeTypeDeclaration objects.
CodeTypeDeclarationCollection(CodeTypeDeclarationCollection)	Initializes a new instance of the CodeTypeDeclarationCollection 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 CodeTypeDeclaration 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(CodeTypeDeclaration)	Adds the specified CodeTypeDeclaration object to the collection.
AddRange(CodeTypeDeclaration[])	Copies the elements of the specified array to the end of the collection.
AddRange(CodeTypeDeclarationCollection)	Adds the contents of another CodeTypeDeclarationCollection object to the end of the collection.
Clear()	Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase)
Contains(CodeTypeDeclaration)	Gets a value that indicates whether the collection contains the specified CodeTypeDeclaration object.
CopyTo(CodeTypeDeclaration[], Int32)	Copies the elements in the CodeTypeDeclarationCollection 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(CodeTypeDeclaration)	Gets the index of the specified CodeTypeDeclaration object in the CodeTypeDeclarationCollection, if it exists in the collection.
Insert(Int32, CodeTypeDeclaration)	Inserts the specified CodeTypeDeclaration 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(CodeTypeDeclaration)	Removes the specified CodeTypeDeclaration 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

• CodeTypeDeclaration