This documentation is archived and is not being maintained.

CodeDirectiveCollection Class

Represents a collection of CodeDirective objects.

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

[SerializableAttribute]
[ComVisibleAttribute(true)]
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
public class CodeDirectiveCollection : CollectionBase

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

The following code example shows the use of the members of the CodeDirectiveCollection class.

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

// Adds a CodeDirective to the collection.
collection.Add(new CodeRegionDirective(CodeRegionMode.Start, "Region1"));

// Adds an array of CodeDirective objects to the collection.
CodeDirective[] directives = { 
    new CodeRegionDirective(CodeRegionMode.Start,"Region1"), 
    new CodeRegionDirective(CodeRegionMode.End,"Region1") };
collection.AddRange(directives);

// Adds a collection of CodeDirective objects to the collection.
CodeDirectiveCollection directivesCollection = new CodeDirectiveCollection();
directivesCollection.Add(new CodeRegionDirective(CodeRegionMode.Start, "Region2"));
directivesCollection.Add(new CodeRegionDirective(CodeRegionMode.End, "Region2"));
collection.AddRange(directivesCollection);

// Tests for the presence of a CodeDirective in the  
// collection, and retrieves its index if it is found.
CodeDirective testDirective = new CodeRegionDirective(CodeRegionMode.Start, "Region1");
int itemIndex = -1;
if (collection.Contains(testDirective))
    itemIndex = collection.IndexOf(testDirective);

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

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

// Inserts a CodeDirective at index 0 of the collection.
collection.Insert(0, new CodeRegionDirective(CodeRegionMode.Start, "Region1"));

// Removes the specified CodeDirective from the collection.
CodeDirective directive = new CodeRegionDirective(CodeRegionMode.Start, "Region1");
collection.Remove(directive);

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

System.Object
  System.Collections.CollectionBase
    System.CodeDom.CodeDirectiveCollection

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
Show: