ModelExplorerTreeContainer.IsExplorableRoleForElement Method

Query whether the specified role should be considered a candidate for display in the explorer. It may not be displayed in the explorer if hidden.

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

Syntax

'Declaration
Protected Friend Overridable Function IsExplorableRoleForElement ( _
    element As ModelElement, _
    role As DomainRoleInfo _
) As Boolean

protected internal virtual bool IsExplorableRoleForElement(
    ModelElement element,
    DomainRoleInfo role
)

protected public:
virtual bool IsExplorableRoleForElement(
    ModelElement^ element, 
    DomainRoleInfo^ role
)

abstract IsExplorableRoleForElement : 
        element:ModelElement * 
        role:DomainRoleInfo -> bool 
override IsExplorableRoleForElement : 
        element:ModelElement * 
        role:DomainRoleInfo -> bool 

 function IsExplorableRoleForElement(
    element : ModelElement, 
    role : DomainRoleInfo
) : boolean

Parameters

• element
  Type: Microsoft.VisualStudio.Modeling.ModelElement
  ModelElement under whose node the role would be displayed

• role
  Type: Microsoft.VisualStudio.Modeling.DomainRoleInfo
  DomainRoleInfo describing the role

Return Value

Type: System.Boolean
True if the role is a candidate for display, else false

Remarks

By default only non-abstract embeddings are represented. Can be overridden, but it is not recommended to include relationships that are not embeddings, as the explorer makes a general assumption that it is only displaying embeddings and its behaviour is undefined if this is not the case

.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.

See Also

Reference

ModelExplorerTreeContainer Class

Microsoft.VisualStudio.Modeling.Shell Namespace