DiagramItemCollection Class

Article
04/26/2013

A collection of DiagramItem instances. A DiagramItem represents a ShapeElement, ShapeField, or ShapeSubField instance on the diagram and is used for such things as hit-testing and selection.

Inheritance Hierarchy

Object
  CollectionBase
    Microsoft.VisualStudio.Modeling.Diagrams.DiagramItemCollection
      Microsoft.VisualStudio.Modeling.Diagrams.HighlightedShapesCollection

Namespace: Microsoft.VisualStudio.Modeling.Diagrams
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0.dll)

Syntax

'Declaration
Public Class DiagramItemCollection _
    Inherits CollectionBase _
    Implements IEnumerable(Of DiagramItem), IEnumerable

public class DiagramItemCollection : CollectionBase, 
    IEnumerable<DiagramItem>, IEnumerable

public ref class DiagramItemCollection : public CollectionBase, 
    IEnumerable<DiagramItem^>, IEnumerable

type DiagramItemCollection =  
    class 
        inherit CollectionBase 
        interface IEnumerable<DiagramItem>
        interface IEnumerable 
    end

public class DiagramItemCollection extends CollectionBase implements IEnumerable<DiagramItem>, IEnumerable

The DiagramItemCollection type exposes the following members.

Constructors

	Name	Description
	DiagramItemCollection	Initializes a new instance of the DiagramItemCollection class.

Top

Properties

	Name	Description
	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	Gets the DiagramItem at the specified position in the collection.
	List	Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)

Top

Methods

	Name	Description
	Add(ICollection)	Adds the DiagramItem of an ICollection to the end of the DiagramItemCollection
	Add(DiagramItem)	Adds a specific DiagramItem to the collection.
	Clear	Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.)
	Contains	Determines whether a DiagramItem is in the collection.
	CopyTo	Copies the DiagramItems of the selection to an Array, starting at a particular Array index.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator	Gets a DiagramItem enumerator for this collection.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Returns the zero-based index of the DiagramItem in the collection.
	Insert	Inserts the DiagramItem 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	Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.)
	OnInsertComplete	Performs additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.)
	OnRemove	Performs additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase.)
	OnRemoveComplete	Performs additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase.)
	OnSet	Performs additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase.)
	OnSetComplete	Performs additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase.)
	OnValidate	Performs additional custom processes when validating a value. (Inherited from CollectionBase.)
	Remove(ICollection)	Removes the specified DiagramItems from an ICollection
	Remove(DiagramItem)	Removes the first occurrence of a specific DiagramItem from the collection.
	RemoveAt	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.)

Top

Explicit Interface Implementations

	Name	Description
	System#Collections#IList#Add	Adds an object to the end of the CollectionBase. (Inherited from CollectionBase.)
	System#Collections#IList#Contains	Determines whether the CollectionBase contains a specific element. (Inherited from CollectionBase.)
	System#Collections#ICollection#CopyTo	Copies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionBase.)
	System#Collections#IList#IndexOf	Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. (Inherited from CollectionBase.)
	System#Collections#IList#Insert	Inserts an element into the CollectionBase at the specified index. (Inherited from CollectionBase.)
	System#Collections#IList#IsFixedSize	Gets a value indicating whether the CollectionBase has a fixed size. (Inherited from CollectionBase.)
	System#Collections#IList#IsReadOnly	Gets a value indicating whether the CollectionBase is read-only. (Inherited from CollectionBase.)
	System#Collections#ICollection#IsSynchronized	Gets a value indicating whether access to the CollectionBase is synchronized (thread safe). (Inherited from CollectionBase.)
	System#Collections#IList#Item	Gets or sets the element at the specified index. (Inherited from CollectionBase.)
	System#Collections#IList#Remove	Removes the first occurrence of a specific object from the CollectionBase. (Inherited from CollectionBase.)
	System#Collections#ICollection#SyncRoot	Gets an object that can be used to synchronize access to the CollectionBase. (Inherited from CollectionBase.)

Top

Thread Safety

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

Share via