ModelElementLocator.NavigateTo Method

Definition

Namespace:

Microsoft.VisualStudio.Modeling.Shell

Assembly:

Microsoft.VisualStudio.Modeling.Sdk.Shell.dll

Package:

Microsoft.VisualStudio.Modeling.Sdk.Shell v17.10.40171

Overloads

NavigateTo(Guid, Diagram)	Open the target diagram.
NavigateTo(Guid, ShapeElement)	Display and select the supplied shape.
NavigateTo(Guid, Diagram, ICollection<DiagramItem>)	Display the target diagram and select the target shapes. All of the target shapes are expected to be in the target diagram. The First shape in the list is the primary selection.
NavigateTo(Guid, DiagramItem, ICollection<DiagramItem>)	Display the targetShape's diagram and select the shape (extend the selection to include the extendedSelection.)
NavigateTo(Guid, DiagramItem, ICollection<DiagramItem>, Boolean)	Display the targetShape's diagram and, if desired, select the shape (extend the selection to include the extendedSelection.)

NavigateTo(Guid, Diagram)

Open the target diagram.

public:
 virtual bool NavigateTo(Guid logicalView, Microsoft::VisualStudio::Modeling::Diagrams::Diagram ^ targetDiagram);

public virtual bool NavigateTo (Guid logicalView, Microsoft.VisualStudio.Modeling.Diagrams.Diagram targetDiagram);

abstract member NavigateTo : Guid * Microsoft.VisualStudio.Modeling.Diagrams.Diagram -> bool
override this.NavigateTo : Guid * Microsoft.VisualStudio.Modeling.Diagrams.Diagram -> bool

Public Overridable Function NavigateTo (logicalView As Guid, targetDiagram As Diagram) As Boolean

Parameters

logicalView

Guid

targetDiagram

Diagram

Returns

Boolean

true if successful

NavigateTo(Guid, ShapeElement)

Display and select the supplied shape.

public:
 bool NavigateTo(Guid logicalView, Microsoft::VisualStudio::Modeling::Diagrams::ShapeElement ^ targetShape);

public bool NavigateTo (Guid logicalView, Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement targetShape);

member this.NavigateTo : Guid * Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement -> bool

Public Function NavigateTo (logicalView As Guid, targetShape As ShapeElement) As Boolean

Parameters

logicalView

Guid

targetShape

ShapeElement

Returns

Boolean

NavigateTo(Guid, Diagram, ICollection<DiagramItem>)

Display the target diagram and select the target shapes. All of the target shapes are expected to be in the target diagram. The First shape in the list is the primary selection.

public:
 bool NavigateTo(Guid logicalView, Microsoft::VisualStudio::Modeling::Diagrams::Diagram ^ targetDiagram, System::Collections::Generic::ICollection<Microsoft::VisualStudio::Modeling::Diagrams::DiagramItem ^> ^ targetSelection);

public bool NavigateTo (Guid logicalView, Microsoft.VisualStudio.Modeling.Diagrams.Diagram targetDiagram, System.Collections.Generic.ICollection<Microsoft.VisualStudio.Modeling.Diagrams.DiagramItem> targetSelection);

member this.NavigateTo : Guid * Microsoft.VisualStudio.Modeling.Diagrams.Diagram * System.Collections.Generic.ICollection<Microsoft.VisualStudio.Modeling.Diagrams.DiagramItem> -> bool

Public Function NavigateTo (logicalView As Guid, targetDiagram As Diagram, targetSelection As ICollection(Of DiagramItem)) As Boolean

Parameters

logicalView

Guid

targetDiagram

Diagram

targetSelection

ICollection<DiagramItem>

collection of ShapeElements to select (expected to be on targetDiagram.)

Returns

Boolean

NavigateTo(Guid, DiagramItem, ICollection<DiagramItem>)

Display the targetShape's diagram and select the shape (extend the selection to include the extendedSelection.)

public:
 bool NavigateTo(Guid logicalView, Microsoft::VisualStudio::Modeling::Diagrams::DiagramItem ^ diagramItem, System::Collections::Generic::ICollection<Microsoft::VisualStudio::Modeling::Diagrams::DiagramItem ^> ^ extendedSelection);

public bool NavigateTo (Guid logicalView, Microsoft.VisualStudio.Modeling.Diagrams.DiagramItem diagramItem, System.Collections.Generic.ICollection<Microsoft.VisualStudio.Modeling.Diagrams.DiagramItem> extendedSelection);

member this.NavigateTo : Guid * Microsoft.VisualStudio.Modeling.Diagrams.DiagramItem * System.Collections.Generic.ICollection<Microsoft.VisualStudio.Modeling.Diagrams.DiagramItem> -> bool

Public Function NavigateTo (logicalView As Guid, diagramItem As DiagramItem, extendedSelection As ICollection(Of DiagramItem)) As Boolean

Parameters

logicalView

Guid

diagramItem

DiagramItem

DiagramItem to navigte to and select

extendedSelection

ICollection<DiagramItem>

collection of ShapeElements to also select, may be an empty list or null.

Returns

Boolean

NavigateTo(Guid, DiagramItem, ICollection<DiagramItem>, Boolean)

Display the targetShape's diagram and, if desired, select the shape (extend the selection to include the extendedSelection.)

public:
 virtual bool NavigateTo(Guid logicalView, Microsoft::VisualStudio::Modeling::Diagrams::DiagramItem ^ targetDiagramItem, System::Collections::Generic::ICollection<Microsoft::VisualStudio::Modeling::Diagrams::DiagramItem ^> ^ extendedSelection, bool changeSelection);

public virtual bool NavigateTo (Guid logicalView, Microsoft.VisualStudio.Modeling.Diagrams.DiagramItem targetDiagramItem, System.Collections.Generic.ICollection<Microsoft.VisualStudio.Modeling.Diagrams.DiagramItem> extendedSelection, bool changeSelection);

abstract member NavigateTo : Guid * Microsoft.VisualStudio.Modeling.Diagrams.DiagramItem * System.Collections.Generic.ICollection<Microsoft.VisualStudio.Modeling.Diagrams.DiagramItem> * bool -> bool
override this.NavigateTo : Guid * Microsoft.VisualStudio.Modeling.Diagrams.DiagramItem * System.Collections.Generic.ICollection<Microsoft.VisualStudio.Modeling.Diagrams.DiagramItem> * bool -> bool

Public Overridable Function NavigateTo (logicalView As Guid, targetDiagramItem As DiagramItem, extendedSelection As ICollection(Of DiagramItem), changeSelection As Boolean) As Boolean

Parameters

logicalView

Guid

targetDiagramItem

DiagramItem

shape to navigte to and select

extendedSelection

ICollection<DiagramItem>

collection of ShapeElements to also select, may be an empty list or null.

changeSelection

Boolean

whether to actually change the selection.

Returns

Boolean