Share via

IVsSymbolicNavigationNotify Interface

  • 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

Facilitates redirection of Goto Definition on a code symbol.

public interface class IVsSymbolicNavigationNotify
public interface class IVsSymbolicNavigationNotify
__interface IVsSymbolicNavigationNotify
[System.Runtime.InteropServices.Guid("4DE38661-BB8F-4B9B-8D2F-425949341BBE")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsSymbolicNavigationNotify
[System.Runtime.InteropServices.Guid("4DE38661-BB8F-4B9B-8D2F-425949341BBE")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsSymbolicNavigationNotify
[<System.Runtime.InteropServices.Guid("4DE38661-BB8F-4B9B-8D2F-425949341BBE")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsSymbolicNavigationNotify = interface
[<System.Runtime.InteropServices.Guid("4DE38661-BB8F-4B9B-8D2F-425949341BBE")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsSymbolicNavigationNotify = interface
Public Interface IVsSymbolicNavigationNotify
Attributes
GuidAttribute InterfaceTypeAttribute

Remarks

Implemented by an advanced code generator system that wants to re-direct the result of Goto Definition on a code symbol. Instead of going to the definition of the symbol in the generated code file, an implementor of this interface can cause the navigation to the definition of the equivalent element in the source file used to generate the code file (e.g. an XAML file).

It is expected that IVsSymbolicNavigationNotify implementations should quickly be able to recognize code files they care about by checking if the input CodeFile matches the naming conventions of the generated files they produce. This might be something like file ends in ".g.vb". It is important that this operation be fast because every "Goto Definition" operation will be passed to these implementations.

Implementors of this interface should register a pointer to their implementation with the IVsSymbolicNavigationManager service.

Methods

OnBeforeNavigateToSymbol(IVsHierarchy, UInt32, String, Int32)

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

Returns the alternate navigation target for the symbol if there is one.

Applies to