HighlightedShapesCollection Class

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.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.12.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
Public method HighlightedShapesCollection Initializes a new instance of the HighlightedShapesCollection class.

Top

Properties

  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.)
Public property Item Gets the DiagramItem at the specified position in the collection. (Inherited from DiagramItemCollection.)

Top

Methods

  Name Description
Public method Add(ICollection) Adds the DiagramItem of an ICollection to the end of the DiagramItemCollection (Inherited from DiagramItemCollection.)
Public method Add(DiagramItem) Adds a DiagramItem to the current highlight list. (Overrides DiagramItemCollection.Add(DiagramItem).)
Public method Add(DiagramItemCollection) Adds the specified DiagramItems to the current highlight list.
Public method Clear Clears the current highlight list.
Public method Contains Determines whether a DiagramItem is in the collection. (Inherited from DiagramItemCollection.)
Public method CopyTo Copies the DiagramItems of the selection to an Array, starting at a particular Array index. (Inherited from DiagramItemCollection.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetDiagramItemsContainingShape Gets a collection of diagram items in the highlight list whose Shape property is the specified shape.
Public method GetEnumerator Gets a DiagramItem enumerator for this collection. (Inherited from DiagramItemCollection.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Returns the zero-based index of the DiagramItem in the collection. (Inherited from DiagramItemCollection.)
Public method Insert Inserts the DiagramItem into the collection at the specified index. (Inherited from DiagramItemCollection.)
Public method Remove(ICollection) Removes the specified DiagramItems from an ICollection (Inherited from DiagramItemCollection.)
Public method Remove(DiagramItem) Removes a DiagramItem from the current highlight list. (Overrides DiagramItemCollection.Remove(DiagramItem).)
Public method Remove(DiagramItemCollection) Removes the specified DiagramItems from the current highlight list.
Public method RemoveAt Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.)
Public method Set(DiagramItem) Replaces the current highlight list with a new single highlight.
Public method Set(DiagramItemCollection) Replaces the current highlight list with a new highlight list.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IList.Add Adds an object to the end of the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate method IList.Contains Determines whether the CollectionBase contains a specific element. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate 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 implemetationPrivate 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 implemetationPrivate method IList.Insert Inserts an element into the CollectionBase at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate property IList.IsFixedSize Gets a value indicating whether the CollectionBase has a fixed size. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate property IList.IsReadOnly Gets a value indicating whether the CollectionBase is read-only. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate property ICollection.IsSynchronized Gets a value indicating whether access to the CollectionBase is synchronized (thread safe). (Inherited from CollectionBase.)
Explicit interface implemetationPrivate property IList.Item Gets or sets the element at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate method IList.Remove Removes the first occurrence of a specific object from the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetationPrivate property 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.

See Also

Reference

Microsoft.VisualStudio.Modeling.Diagrams Namespace