This topic has not yet been rated - Rate this topic

CodeAttributeDeclarationCollection Class

Represents a collection of CodeAttributeDeclaration objects.

System.Object
  System.Collections.CollectionBase
    System.CodeDom.CodeAttributeDeclarationCollection

Namespace:  System.CodeDom
Assembly:  System (in System.dll)
[SerializableAttribute]
[ComVisibleAttribute(true)]
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
public class CodeAttributeDeclarationCollection : CollectionBase

The CodeAttributeDeclarationCollection type exposes the following members.

  Name Description
Public method CodeAttributeDeclarationCollection() Initializes a new instance of the CodeAttributeDeclarationCollection class.
Public method CodeAttributeDeclarationCollection(CodeAttributeDeclaration[]) Initializes a new instance of the CodeAttributeDeclarationCollection class containing the specified array of CodeAttributeDeclaration objects.
Public method CodeAttributeDeclarationCollection(CodeAttributeDeclarationCollection) Initializes a new instance of the CodeAttributeDeclarationCollection class containing the elements of the specified source collection.
Top
  Name Description
Public property Capacity Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.)
Public property Count Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.)
Protected property InnerList Gets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)
Public property Item Gets or sets the CodeAttributeDeclaration object at the specified index.
Protected property List Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)
Top
  Name Description
Public method Add Adds a CodeAttributeDeclaration object with the specified value to the collection.
Public method AddRange(CodeAttributeDeclaration[]) Copies the elements of the specified CodeAttributeDeclaration array to the end of the collection.
Public method AddRange(CodeAttributeDeclarationCollection) Copies the contents of another CodeAttributeDeclarationCollection object to the end of the collection.
Public method Clear Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.)
Public method Contains Gets or sets a value that indicates whether the collection contains the specified CodeAttributeDeclaration object.
Public method CopyTo Copies the collection objects to a one-dimensional Array instance beginning at the specified index.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Gets the index of the specified CodeAttributeDeclaration object in the collection, if it exists in the collection.
Public method Insert Inserts the specified CodeAttributeDeclaration object into the collection at the specified index.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnClear Performs additional custom processes when clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnClearComplete Performs additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnInsert Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnInsertComplete Performs additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnRemove Performs additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnRemoveComplete Performs additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnSet Performs additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnSetComplete Performs additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnValidate Performs additional custom processes when validating a value. (Inherited from CollectionBase.)
Public method Remove Removes the specified CodeAttributeDeclaration object from the collection.
Public method RemoveAt Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method ICollection.CopyTo Copies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionBase.)
Explicit interface implemetation Private property ICollection.IsSynchronized Gets a value indicating whether access to the CollectionBase is synchronized (thread safe). (Inherited from CollectionBase.)
Explicit interface implemetation Private property ICollection.SyncRoot Gets an object that can be used to synchronize access to the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IList.Add Adds an object to the end of the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IList.Contains Determines whether the CollectionBase contains a specific element. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IList.IndexOf Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IList.Insert Inserts an element into the CollectionBase at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetation Private property IList.IsFixedSize Gets a value indicating whether the CollectionBase has a fixed size. (Inherited from CollectionBase.)
Explicit interface implemetation Private property IList.IsReadOnly Gets a value indicating whether the CollectionBase is read-only. (Inherited from CollectionBase.)
Explicit interface implemetation Private property IList.Item Gets or sets the element at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IList.Remove Removes the first occurrence of a specific object from the CollectionBase. (Inherited from CollectionBase.)
Top

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

The following example demonstrates the use of the CodeAttributeDeclarationCollection class methods.


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

// Adds a CodeAttributeDeclaration to the collection.
collection.Add( new CodeAttributeDeclaration("DescriptionAttribute",  new CodeAttributeArgument(new CodePrimitiveExpression("Test Description"))) );

// Adds an array of CodeAttributeDeclaration objects 
// to the collection.
CodeAttributeDeclaration[] declarations = { new CodeAttributeDeclaration(), new CodeAttributeDeclaration() };
collection.AddRange( declarations );

// Adds a collection of CodeAttributeDeclaration objects 
// to the collection.
CodeAttributeDeclarationCollection declarationsCollection = new CodeAttributeDeclarationCollection();
declarationsCollection.Add( new CodeAttributeDeclaration("DescriptionAttribute", new CodeAttributeArgument(new CodePrimitiveExpression("Test Description"))) );
declarationsCollection.Add( new CodeAttributeDeclaration("BrowsableAttribute", new CodeAttributeArgument(new CodePrimitiveExpression(true))) );
collection.AddRange( declarationsCollection );

// Tests for the presence of a CodeAttributeDeclaration in 
// the collection, and retrieves its index if it is found.
CodeAttributeDeclaration testdeclaration = new CodeAttributeDeclaration("DescriptionAttribute", new CodeAttributeArgument(new CodePrimitiveExpression("Test Description")) );
int itemIndex = -1;
if( collection.Contains( testdeclaration ) )
    itemIndex = collection.IndexOf( testdeclaration );

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

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

// Inserts a CodeAttributeDeclaration at index 0 of the collection.
collection.Insert( 0, new CodeAttributeDeclaration("DescriptionAttribute", new CodeAttributeArgument(new CodePrimitiveExpression("Test Description"))) );

// Removes the specified CodeAttributeDeclaration from 
// the collection.
CodeAttributeDeclaration declaration = new CodeAttributeDeclaration("DescriptionAttribute", new CodeAttributeArgument(new CodePrimitiveExpression("Test Description")) );
collection.Remove( declaration );

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


.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ