This documentation is archived and is not being maintained.

CodeTypeMemberCollection Class

Represents a collection of CodeTypeMember objects.

Namespace:  System.CodeDom
Assembly:  System (in System.dll)

'Declaration
<SerializableAttribute> _
<ComVisibleAttribute(True)> _
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)> _
Public Class CodeTypeMemberCollection _
	Inherits CollectionBase
'Usage
Dim instance As CodeTypeMemberCollection

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

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. 
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)

System.Object
  System.Collections.CollectionBase
    System.CodeDom.CodeTypeMemberCollection

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: