DepthFirstElementAndLinkWalker Class

  • Article

Visits the elements in the model, applying an action to each one. Links can be included.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.Modeling.ElementWalker
    Microsoft.VisualStudio.Modeling.DepthFirstElementWalker
      Microsoft.VisualStudio.Modeling.DepthFirstElementAndLinkWalker

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

Syntax

'Declaration
Public Class DepthFirstElementAndLinkWalker _
    Inherits DepthFirstElementWalker

public class DepthFirstElementAndLinkWalker : DepthFirstElementWalker

public ref class DepthFirstElementAndLinkWalker : public DepthFirstElementWalker

type DepthFirstElementAndLinkWalker =  
    class 
        inherit DepthFirstElementWalker 
    end

public class DepthFirstElementAndLinkWalker extends DepthFirstElementWalker

The DepthFirstElementAndLinkWalker type exposes the following members.

Constructors

  Name Description
Public method DepthFirstElementAndLinkWalker(IElementVisitor, IElementVisitorFilter) Constructor that takes an ElementVisitor.
Public method DepthFirstElementAndLinkWalker(IElementVisitor, IElementVisitorFilter, Boolean) Constructor that takes an ElementVisitor.

Top

Properties

  Name Description
Public property BypassDemandLoading Allows the walker to bypass demand loading while traversing (Inherited from ElementWalker.)
Public property Filter Get or set the IElementVisitorFilter for use during traversal (Inherited from ElementWalker.)
Public property IncludeLinks Returns true if the walker will include element links in calls to the visitor function (Inherited from ElementWalker.)
Public property InternalElementList Get the internal list of elements that will be visited (Inherited from ElementWalker.)
Public property Store Get the internal list of elements that will be visited (Inherited from ElementWalker.)
Public property Visitor Get or set the IElementVisitor for use during traversal (Inherited from ElementWalker.)

Top

Methods

  Name Description
Protected method BeginTraverseElement Virtual method called when the walker is about visit the specified element and its related elements. (Inherited from DepthFirstElementWalker.)
Public method DoTraverse Traverse the model starting at the specified starting element. (Inherited from DepthFirstElementWalker.)
Protected method EndTraverseElement Virtual method indicates that the walker has finished traversing into the specified element. (Inherited from DepthFirstElementWalker.)
Public method Equals 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 GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetRelatedElements Get the list of immediately neighboring elements that should be visited, in the order in which they should be visited. (Overrides DepthFirstElementWalker.GetRelatedElements(ModelElement).)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MarkForRemovalFromInternalElementList Mark an element for removal from the InternalElementList. We mark first and remove later at the end so that the indices remain valid. When marking elements as visited, we store an index in the hashtable which tells us the order that the element was visited in. If the elements were put into the InternalElementList in that order, we can find the element easily using the index. If not a linear search will be used to find the element. (Inherited from ElementWalker.)
Protected method MarkVisited Mark an element as having been already visited (Inherited from ElementWalker.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method RemoveMarkedElements Removes the elements that are marked for removal. Call this at the end of the traversal so that the indices in alreadyVisited remain valid. (Inherited from ElementWalker.)
Public method Reset Reset the visitor so that it can start traversing again. This is necessary to clear out the internal list of previously visited elements. (Inherited from ElementWalker.)
Protected method ShouldVisitLinkAgain True if the link has been visited before the currentElement (one of its roleplayers) was visited. (Inherited from ElementWalker.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Traverse(ModelElement) Traverse the model starting at the specified starting element. (Inherited from ElementWalker.)
Public method Traverse(ICollection<ModelElement>) Traverse the model starting at the specified starting elements. (Inherited from ElementWalker.)
Public method Visited determines if the given element has been visited or not (Inherited from ElementWalker.)

Top

Remarks

You can inherit from this class to define a walker. Override GetRelatedElements.

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 Namespace