ElementWalker Class
Enables various traversals of the model starting from a particular element.
Inheritance Hierarchy
Object
Microsoft.VisualStudio.Modeling.ElementWalker
Microsoft.VisualStudio.Modeling.BreadthFirstRolePlayerFirstElementWalker
Microsoft.VisualStudio.Modeling.DepthFirstElementWalker
Namespace: Microsoft.VisualStudio.Modeling
Assembly: Microsoft.VisualStudio.Modeling.Sdk.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.11.0.dll)
Syntax
'Declaration
Public MustInherit Class ElementWalker
public abstract class ElementWalker
public ref class ElementWalker abstract
[<AbstractClass>]
type ElementWalker = class end
public abstract class ElementWalker
The ElementWalker type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
ElementWalker(IElementVisitor, IElementVisitorFilter) | Constructor that takes an ElementVisitor. |
|
ElementWalker(IElementVisitor, IElementVisitorFilter, Boolean) | Constructor that takes an ElementVisitor. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
BypassDemandLoading | Allows the walker to bypass demand loading while traversing |
|
Filter | Get or set the IElementVisitorFilter for use during traversal |
|
IncludeLinks | Returns true if the walker will include element links in calls to the visitor function |
|
InternalElementList | Get the internal list of elements that will be visited |
|
Store | Get the internal list of elements that will be visited |
|
Visitor | Get or set the IElementVisitor for use during traversal |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
DoTraverse | Traverse the model starting at the specified starting element. |
|
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.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
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. |
|
MarkVisited | Mark an element as having been already visited |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
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. |
|
Reset | Reset the visitor so that it can start traversing again. This is necessary to clear out the internal list of previously visited elements. |
|
ShouldVisitLinkAgain | True if the link has been visited before the currentElement (one of its roleplayers) was visited. |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
Traverse(ModelElement) | Traverse the model starting at the specified starting element. |
|
Traverse(ICollection<ModelElement>) | Traverse the model starting at the specified starting elements. |
|
Visited | determines if the given element has been visited or not |
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.