CodeDirectiveCollection Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Represents a collection of CodeDirective objects.

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

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

<SerializableAttribute>
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)>
<ComVisibleAttribute(True)>
Public Class CodeDirectiveCollection
	Inherits CollectionBase

NameDescription
System_CAPS_pubmethodCodeDirectiveCollection()

Initializes a new instance of the CodeDirectiveCollection class.

System_CAPS_pubmethodCodeDirectiveCollection(CodeDirective())

Initializes a new instance of the CodeDirectiveCollection class with the code directive objects in the specified array.

System_CAPS_pubmethodCodeDirectiveCollection(CodeDirectiveCollection)

Initializes a new instance of the CodeDirectiveCollection class with the elements in the specified code directive collection.

NameDescription
System_CAPS_pubpropertyCapacity

Gets or sets the number of elements that the CollectionBase can contain.(Inherited from CollectionBase.)

System_CAPS_pubpropertyCount

Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden.(Inherited from CollectionBase.)

System_CAPS_protpropertyInnerList

Gets an ArrayList containing the list of elements in the CollectionBase instance.(Inherited from CollectionBase.)

System_CAPS_pubpropertyItem(Int32)

Gets or sets the CodeDirective object at the specified index in the collection.

System_CAPS_protpropertyList

Gets an IList containing the list of elements in the CollectionBase instance.(Inherited from CollectionBase.)

NameDescription
System_CAPS_pubmethodAdd(CodeDirective)

Adds the specified CodeDirective object to the collection.

System_CAPS_pubmethodAddRange(CodeDirective())

Adds an array of CodeDirective objects to the end of the collection.

System_CAPS_pubmethodAddRange(CodeDirectiveCollection)

Adds the contents of the specified CodeDirectiveCollection object to the end of the collection.

System_CAPS_pubmethodClear()

Removes all objects from the CollectionBase instance. This method cannot be overridden.(Inherited from CollectionBase.)

System_CAPS_pubmethodContains(CodeDirective)

Gets a value indicating whether the collection contains the specified CodeDirective object.

System_CAPS_pubmethodCopyTo(CodeDirective(), Int32)

Copies the contents of the collection to a one-dimensional array beginning at the specified index.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Returns an enumerator that iterates through the CollectionBase instance.(Inherited from CollectionBase.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIndexOf(CodeDirective)

Gets the index in the collection of the specified CodeDirective object, if it exists in the collection.

System_CAPS_pubmethodInsert(Int32, CodeDirective)

Inserts the specified CodeDirective object into the collection at the specified index.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnClear()

Performs additional custom processes when clearing the contents of the CollectionBase instance.(Inherited from CollectionBase.)

System_CAPS_protmethodOnClearComplete()

Performs additional custom processes after clearing the contents of the CollectionBase instance.(Inherited from CollectionBase.)

System_CAPS_protmethodOnInsert(Int32, Object)

Performs additional custom processes before inserting a new element into the CollectionBase instance.(Inherited from CollectionBase.)

System_CAPS_protmethodOnInsertComplete(Int32, Object)

Performs additional custom processes after inserting a new element into the CollectionBase instance.(Inherited from CollectionBase.)

System_CAPS_protmethodOnRemove(Int32, Object)

Performs additional custom processes when removing an element from the CollectionBase instance.(Inherited from CollectionBase.)

System_CAPS_protmethodOnRemoveComplete(Int32, Object)

Performs additional custom processes after removing an element from the CollectionBase instance.(Inherited from CollectionBase.)

System_CAPS_protmethodOnSet(Int32, Object, Object)

Performs additional custom processes before setting a value in the CollectionBase instance.(Inherited from CollectionBase.)

System_CAPS_protmethodOnSetComplete(Int32, Object, Object)

Performs additional custom processes after setting a value in the CollectionBase instance.(Inherited from CollectionBase.)

System_CAPS_protmethodOnValidate(Object)

Performs additional custom processes when validating a value.(Inherited from CollectionBase.)

System_CAPS_pubmethodRemove(CodeDirective)

Removes the specified CodeDirective object from the collection.

System_CAPS_pubmethodRemoveAt(Int32)

Removes the element at the specified index of the CollectionBase instance. This method is not overridable.(Inherited from CollectionBase.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection.CopyTo(Array, Int32)

Copies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array.(Inherited from CollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Add(Object)

Adds an object to the end of the CollectionBase.(Inherited from CollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Contains(Object)

Determines whether the CollectionBase contains a specific element.(Inherited from CollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.IndexOf(Object)

Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase.(Inherited from CollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Insert(Int32, Object)

Inserts an element into the CollectionBase at the specified index.(Inherited from CollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Remove(Object)

Removes the first occurrence of a specific object from the CollectionBase.(Inherited from CollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.IsSynchronized

Gets a value indicating whether access to the CollectionBase is synchronized (thread safe).(Inherited from CollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.SyncRoot

Gets an object that can be used to synchronize access to the CollectionBase.(Inherited from CollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsFixedSize

Gets a value indicating whether the CollectionBase has a fixed size.(Inherited from CollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsReadOnly

Gets a value indicating whether the CollectionBase is read-only.(Inherited from CollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.Item(Int32)

Gets or sets the element at the specified index.(Inherited from CollectionBase.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast(Of TResult)()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType(Of TResult)()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

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.
        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 'CodeDirectiveCollectionExample 
End Class 'Class1 

.NET Framework
Available since 2.0

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

Return to top
Show: