HighlightedShapesCollection Class

Article
2013-02-04

Collection of shapes and DiagramItems that are highlighted on the design surface.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public NotInheritable Class HighlightedShapesCollection _
    Inherits DiagramItemCollection

public sealed class HighlightedShapesCollection : DiagramItemCollection

public ref class HighlightedShapesCollection sealed : public DiagramItemCollection

[<Sealed>]
type HighlightedShapesCollection =  
    class
        inherit DiagramItemCollection
    end

public final class HighlightedShapesCollection extends DiagramItemCollection

The HighlightedShapesCollection type exposes the following members.

Constructors

	Name	Description
	HighlightedShapesCollection	Initializes a new instance of the HighlightedShapesCollection 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. (Inherited from DiagramItemCollection.)
	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 (Inherited from DiagramItemCollection.)
	Add(DiagramItem)	Adds a DiagramItem to the current highlight list. (Overrides DiagramItemCollection.Add(DiagramItem).)
	Add(DiagramItemCollection)	Adds the specified DiagramItems to the current highlight list.
	Clear	Clears the current highlight list.
	Contains	Determines whether a DiagramItem is in the collection. (Inherited from DiagramItemCollection.)
	CopyTo	Copies the DiagramItems of the selection to an Array, starting at a particular Array index. (Inherited from DiagramItemCollection.)
	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.)
	GetDiagramItemsContainingShape	Gets a collection of diagram items in the highlight list whose Shape property is the specified shape.
	GetEnumerator	Gets a DiagramItem enumerator for this collection. (Inherited from DiagramItemCollection.)
	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. (Inherited from DiagramItemCollection.)
	Insert	Inserts the DiagramItem into the collection at the specified index. (Inherited from DiagramItemCollection.)
	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 (Inherited from DiagramItemCollection.)
	Remove(DiagramItem)	Removes a DiagramItem from the current highlight list. (Overrides DiagramItemCollection.Remove(DiagramItem).)
	Remove(DiagramItemCollection)	Removes the specified DiagramItems from the current highlight list.
	RemoveAt	Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.)
	Set(DiagramItem)	Replaces the current highlight list with a new single highlight.
	Set(DiagramItemCollection)	Replaces the current highlight list with a new highlight list.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

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