VsSymbolicNavigationManagerClass Class

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assembly:
Microsoft.VisualStudio.Shell.Interop.9.0.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

Represents a global service that manages the list of IVsSymbolicNavigationNotify handlers that are registered on a project-scoped basis. This interface is available via QueryService(Type, Object).

public ref class VsSymbolicNavigationManagerClass : Microsoft::VisualStudio::Shell::Interop::VsSymbolicNavigationManager
[Windows::Foundation::Metadata::WebHostHidden]
class VsSymbolicNavigationManagerClass : Microsoft::VisualStudio::Shell::Interop::VsSymbolicNavigationManager
[System.Runtime.InteropServices.ClassInterface(0)]
[System.Runtime.InteropServices.Guid("3FD6EE6A-1DF2-4305-9946-2146D0E16930")]
[System.Runtime.InteropServices.TypeLibType(2)]
public class VsSymbolicNavigationManagerClass : Microsoft.VisualStudio.Shell.Interop.VsSymbolicNavigationManager
[System.Runtime.InteropServices.Guid("3FD6EE6A-1DF2-4305-9946-2146D0E16930")]
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
public class VsSymbolicNavigationManagerClass : Microsoft.VisualStudio.Shell.Interop.VsSymbolicNavigationManager
[<System.Runtime.InteropServices.ClassInterface(0)>]
[<System.Runtime.InteropServices.Guid("3FD6EE6A-1DF2-4305-9946-2146D0E16930")>]
[<System.Runtime.InteropServices.TypeLibType(2)>]
type VsSymbolicNavigationManagerClass = class
    interface IVsSymbolicNavigationManager
    interface VsSymbolicNavigationManager
[<System.Runtime.InteropServices.Guid("3FD6EE6A-1DF2-4305-9946-2146D0E16930")>]
[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)>]
type VsSymbolicNavigationManagerClass = class
    interface VsSymbolicNavigationManager
    interface IVsSymbolicNavigationManager
Public Class VsSymbolicNavigationManagerClass
Implements VsSymbolicNavigationManager
Inheritance
Object
VsSymbolicNavigationManagerClass
Attributes
ClassInterfaceAttribute GuidAttribute TypeLibTypeAttribute
Implements
IVsSymbolicNavigationManager VsSymbolicNavigationManager

Remarks

The language service of a code language should call OnBeforeNavigateToSymbol on this service before performing a “go to definition” type of navigation to a symbol in code. This allows an advanced code generator system to overtake normal navigation and cause navigation to the definition of a symbol in the source document that generated the code definition.

This service loops through all of the registered objects, calling its symbol querying methods, until the first one handles the symbol. The order of the calls is undefined. Implementations of these methods should quickly respond false for any irrelevant files by checking the file extension of the input code file. Other quick checks should be made if the input IVsHierarchy is supported.

Constructors

VsSymbolicNavigationManagerClass()

Creates a new instance of the VsSymbolicNavigationManagerClass class.

Methods

OnBeforeNavigateToSymbol(IVsHierarchy, UInt32, String, Int32)

Determines if there is an alternate source file within which to navigate for a specified code symbol (GoTo Definition operation).
QueryNavigateToSymbol(IVsHierarchy, UInt32, String, IVsHierarchy, UInt32, TextSpan[], Int32)

Retrieves the alternate navigation target for the specified symbol,l if there is one.
RegisterSymbolicNavigationNotify(IVsSymbolicNavigationNotify, UInt32)

Registers the specified IVsSymbolicNavigationManager handler.
UnregisterSymbolicNavigationNotify(UInt32)

Unregisters the specified IVsSymbolicNavigationManager handler.

Applies to