CodeTypeMemberCollection Class

Definition

Namespace:

System.CodeDom

Assembly:

System.CodeDom.dll

Represents a collection of CodeTypeMember objects.

public ref class CodeTypeMemberCollection : System::Collections::CollectionBase

public class CodeTypeMemberCollection : System.Collections.CollectionBase

type CodeTypeMemberCollection = class
    inherit CollectionBase

Public Class CodeTypeMemberCollection
Inherits CollectionBase

Inheritance

Object

CollectionBase

CodeTypeMemberCollection

Examples

The following code example demonstrates the use of the CodeTypeMemberCollection 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 CodeTypeMemberCollection.
CodeTypeMemberCollection^ collection = gcnew CodeTypeMemberCollection;

// Adds a CodeTypeMember to the collection.
collection->Add( gcnew CodeMemberField( "System.String","TestStringField" ) );

// Adds an array of CodeTypeMember objects to the collection.
array<CodeTypeMember^>^members = {gcnew CodeMemberField( "System.String","TestStringField1" ),gcnew CodeMemberField( "System.String","TestStringField2" )};
collection->AddRange( members );

// Adds a collection of CodeTypeMember objects to the collection.
CodeTypeMemberCollection^ membersCollection = gcnew CodeTypeMemberCollection;
membersCollection->Add( gcnew CodeMemberField( "System.String","TestStringField1" ) );
membersCollection->Add( gcnew CodeMemberField( "System.String","TestStringField2" ) );
collection->AddRange( membersCollection );

// Tests for the presence of a CodeTypeMember in the collection, 
// and retrieves its index if it is found.
CodeTypeMember^ testMember = gcnew CodeMemberField( "System.String","TestStringField" );
int itemIndex = -1;
if ( collection->Contains( testMember ) )
   itemIndex = collection->IndexOf( testMember );

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

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

// Inserts a CodeTypeMember at index 0 of the collection.
collection->Insert( 0, gcnew CodeMemberField( "System.String","TestStringField" ) );

// Removes the specified CodeTypeMember from the collection.
CodeTypeMember^ member = gcnew CodeMemberField( "System.String","TestStringField" );
collection->Remove( member );

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

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

// Adds a CodeTypeMember to the collection.
collection.Add( new CodeMemberField("System.String", "TestStringField") );

// Adds an array of CodeTypeMember objects to the collection.
CodeTypeMember[] members = { new CodeMemberField("System.String", "TestStringField1"), new CodeMemberField("System.String", "TestStringField2") };
collection.AddRange( members );

// Adds a collection of CodeTypeMember objects to the collection.
CodeTypeMemberCollection membersCollection = new CodeTypeMemberCollection();
membersCollection.Add( new CodeMemberField("System.String", "TestStringField1") );
membersCollection.Add( new CodeMemberField("System.String", "TestStringField2") );
collection.AddRange( membersCollection );

// Tests for the presence of a CodeTypeMember in the collection,
// and retrieves its index if it is found.
CodeTypeMember testMember = new CodeMemberField("System.String", "TestStringField");
int itemIndex = -1;
if( collection.Contains( testMember ) )
    itemIndex = collection.IndexOf( testMember );

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

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

// Inserts a CodeTypeMember at index 0 of the collection.
collection.Insert( 0, new CodeMemberField("System.String", "TestStringField") );

// Removes the specified CodeTypeMember from the collection.
CodeTypeMember member = new CodeMemberField("System.String", "TestStringField");
collection.Remove( member );

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

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

' Adds a CodeTypeMember to the collection.
collection.Add(New CodeMemberField("System.String", "TestStringField"))

' Adds an array of CodeTypeMember objects to the collection.
Dim members As CodeTypeMember() = {New CodeMemberField("System.String", "TestStringField1"), New CodeMemberField("System.String", "TestStringField2")}
collection.AddRange(members)

' Adds a collection of CodeTypeMember objects to the collection.
Dim membersCollection As New CodeTypeMemberCollection()
membersCollection.Add(New CodeMemberField("System.String", "TestStringField1"))
membersCollection.Add(New CodeMemberField("System.String", "TestStringField2"))
collection.AddRange(membersCollection)

' Tests for the presence of a CodeTypeMember within the collection, and retrieves its index if it is within the collection.
Dim testMember = New CodeMemberField("System.String", "TestStringField")
Dim itemIndex As Integer = -1
If collection.Contains(testMember) Then
    itemIndex = collection.IndexOf(testMember)
End If

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

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

' Inserts a CodeTypeMember at index 0 of the collection.
collection.Insert(0, New CodeMemberField("System.String", "TestStringField"))

' Removes the specified CodeTypeMember from the collection.
Dim member = New CodeMemberField("System.String", "TestStringField")
collection.Remove(member)

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

Remarks

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

Constructors

CodeTypeMemberCollection()	Initializes a new instance of the CodeTypeMemberCollection class.
CodeTypeMemberCollection(CodeTypeMember[])	Initializes a new instance of the CodeTypeMemberCollection class containing the specified array of CodeTypeMember objects.
CodeTypeMemberCollection(CodeTypeMemberCollection)	Initializes a new instance of the CodeTypeMemberCollection class containing 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 CodeTypeMember 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(CodeTypeMember)	Adds a CodeTypeMember with the specified value to the collection.
AddRange(CodeTypeMember[])	Copies the elements of the specified CodeTypeMember array to the end of the collection.
AddRange(CodeTypeMemberCollection)	Adds the contents of another CodeTypeMemberCollection to the end of the collection.
Clear()	Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase)
Contains(CodeTypeMember)	Gets a value indicating whether the collection contains the specified CodeTypeMember.
CopyTo(CodeTypeMember[], Int32)	Copies the collection objects to a one-dimensional Array instance, beginning 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(CodeTypeMember)	Gets the index in the collection of the specified CodeTypeMember, if it exists in the collection.
Insert(Int32, CodeTypeMember)	Inserts the specified CodeTypeMember 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(CodeTypeMember)	Removes a specific CodeTypeMember 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

• CodeTypeMember