CodeDirectiveCollection Class

Definition

Namespace:

System.CodeDom

Assembly:

System.CodeDom.dll

Represents a collection of CodeDirective objects.

public ref class CodeDirectiveCollection : System::Collections::CollectionBase

public class CodeDirectiveCollection : System.Collections.CollectionBase

type CodeDirectiveCollection = class
    inherit CollectionBase

Public Class CodeDirectiveCollection
Inherits CollectionBase

Inheritance

Object

CollectionBase

CodeDirectiveCollection

Examples

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

        ' Creates an empty CodeDirectiveCollection.
        Dim collection As New CodeDirectiveCollection()
        ' Adds a CodeDirective to the collection.
        collection.Add(New CodeRegionDirective(CodeRegionMode.Start, "Region1"))
        ' Adds an array of CodeDirective objects to the collection.
        Dim directives As CodeDirective() = {New CodeRegionDirective(CodeRegionMode.Start, "Region1"), New CodeRegionDirective(CodeRegionMode.End, "Region1")}
        collection.AddRange(directives)

        ' Adds a collection of CodeDirective objects to the collection.
        Dim directivesCollection As 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.
        Dim testDirective = New CodeRegionDirective(CodeRegionMode.Start, "Region1")
        Dim itemIndex As Integer = -1
        If collection.Contains(testDirective) Then
            itemIndex = collection.IndexOf(testDirective)
        End If
        ' 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.
        Dim collectionCount As Integer = 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.
        Dim directive = New CodeRegionDirective(CodeRegionMode.Start, "Region1")
        collection.Remove(directive)
        ' Removes the CodeDirective at index 0.
        collection.RemoveAt(0)
    
    End Sub
End Class

Remarks

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

Constructors

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

• CodeDirective