DefaultVisitorFilter.ShouldVisitRelationship Method

Article
2013-11-24

Called to ask the filter if a particular relationship from a source element should be included in the traversal. By default, returns true.

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

Syntax

'Declaration
Public Function ShouldVisitRelationship ( _
    walker As ElementWalker, _
    sourceElement As ModelElement, _
    sourceRoleInfo As DomainRoleInfo, _
    domainRelationshipInfo As DomainRelationshipInfo, _
    targetRelationship As ElementLink _
) As VisitorFilterResult

public VisitorFilterResult ShouldVisitRelationship(
    ElementWalker walker,
    ModelElement sourceElement,
    DomainRoleInfo sourceRoleInfo,
    DomainRelationshipInfo domainRelationshipInfo,
    ElementLink targetRelationship
)

public:
virtual VisitorFilterResult ShouldVisitRelationship(
    ElementWalker^ walker, 
    ModelElement^ sourceElement, 
    DomainRoleInfo^ sourceRoleInfo, 
    DomainRelationshipInfo^ domainRelationshipInfo, 
    ElementLink^ targetRelationship
) sealed

abstract ShouldVisitRelationship : 
        walker:ElementWalker * 
        sourceElement:ModelElement * 
        sourceRoleInfo:DomainRoleInfo * 
        domainRelationshipInfo:DomainRelationshipInfo * 
        targetRelationship:ElementLink -> VisitorFilterResult  
override ShouldVisitRelationship : 
        walker:ElementWalker * 
        sourceElement:ModelElement * 
        sourceRoleInfo:DomainRoleInfo * 
        domainRelationshipInfo:DomainRelationshipInfo * 
        targetRelationship:ElementLink -> VisitorFilterResult

public final function ShouldVisitRelationship(
    walker : ElementWalker, 
    sourceElement : ModelElement, 
    sourceRoleInfo : DomainRoleInfo, 
    domainRelationshipInfo : DomainRelationshipInfo, 
    targetRelationship : ElementLink
) : VisitorFilterResult

Parameters

walker
Type: Microsoft.VisualStudio.Modeling.ElementWalker

ElementWalker that is traversing the model

sourceElement
Type: Microsoft.VisualStudio.Modeling.ModelElement

Model Element playing the source role

sourceRoleInfo
Type: Microsoft.VisualStudio.Modeling.DomainRoleInfo

DomainRoleInfo that the source element plays in the relationship

domainRelationshipInfo
Type: Microsoft.VisualStudio.Modeling.DomainRelationshipInfo

DomainRelationshipInfo for the ElementLink in question

targetRelationship
Type: Microsoft.VisualStudio.Modeling.ElementLink

Element link that is being considered

Return Value

Type: Microsoft.VisualStudio.Modeling.VisitorFilterResult
Yes if the relationship should be traversed

Implements

IElementVisitorFilter.ShouldVisitRelationship(ElementWalker, ModelElement, DomainRoleInfo, DomainRelationshipInfo, ElementLink)

Remarks

Called to ask the filter if a particular relationship from a source element should be included in the traversal. By default, returns true.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via