ModelExplorerTreeContainer.IsExplorableRoleForElement Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Modeling.Shell

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Shell.15.0.dll

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Shell.dll

Package:: Microsoft.VisualStudio.Modeling.Sdk.Shell v17.10.40102

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

protected public:
 virtual bool IsExplorableRoleForElement(Microsoft::VisualStudio::Modeling::ModelElement ^ element, Microsoft::VisualStudio::Modeling::DomainRoleInfo ^ role);

protected internal virtual bool IsExplorableRoleForElement (Microsoft.VisualStudio.Modeling.ModelElement element, Microsoft.VisualStudio.Modeling.DomainRoleInfo role);

abstract member IsExplorableRoleForElement : Microsoft.VisualStudio.Modeling.ModelElement * Microsoft.VisualStudio.Modeling.DomainRoleInfo -> bool
override this.IsExplorableRoleForElement : Microsoft.VisualStudio.Modeling.ModelElement * Microsoft.VisualStudio.Modeling.DomainRoleInfo -> bool

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

Parameters

element: ModelElement

ModelElement under whose node the role would be displayed

role: DomainRoleInfo

DomainRoleInfo describing the role

Returns

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

Applies to

Share via