VsSymbolicNavigationManagerClass Class

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.


Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.9.0 (in Microsoft.VisualStudio.Shell.Interop.9.0.dll)

public class VsSymbolicNavigationManagerClass : IVsSymbolicNavigationManager, 

The VsSymbolicNavigationManagerClass type exposes the following members.

Public methodVsSymbolicNavigationManagerClassCreates a new instance of the VsSymbolicNavigationManagerClass class.

Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOnBeforeNavigateToSymbolDetermines if there is an alternate source file within which to navigate for a specified code symbol (GoTo Definition operation).
Public methodQueryNavigateToSymbolRetrieves the alternate navigation target for the specified symbol,l if there is one.
Public methodRegisterSymbolicNavigationNotifyRegisters the specified IVsSymbolicNavigationManager handler.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUnregisterSymbolicNavigationNotifyUnregisters the specified IVsSymbolicNavigationManager handler.

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft