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)

System.Object
  Microsoft.VisualStudio.Shell.Interop.VsSymbolicNavigationManagerClass

[ClassInterfaceAttribute(0)]
[TypeLibTypeAttribute(2)]
[GuidAttribute("3FD6EE6A-1DF2-4305-9946-2146D0E16930")]
public class VsSymbolicNavigationManagerClass : IVsSymbolicNavigationManager, 
	VsSymbolicNavigationManager

NameDescription
System_CAPS_pubmethodVsSymbolicNavigationManagerClass()

Creates a new instance of the VsSymbolicNavigationManagerClass class.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodOnBeforeNavigateToSymbol(IVsHierarchy, UInt32, String, Int32)

Determines if there is an alternate source file within which to navigate for a specified code symbol (GoTo Definition operation).

System_CAPS_pubmethodQueryNavigateToSymbol(IVsHierarchy, UInt32, String, IVsHierarchy, UInt32, TextSpan[], Int32)

Retrieves the alternate navigation target for the specified symbol,l if there is one.

System_CAPS_pubmethodRegisterSymbolicNavigationNotify(IVsSymbolicNavigationNotify, UInt32)

Registers the specified IVsSymbolicNavigationManager handler.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUnregisterSymbolicNavigationNotify(UInt32)

Unregisters the specified IVsSymbolicNavigationManager handler.

The language service of a code language should call M:Microsoft.VisualStudio.Shell.Interop.VsSymbolicNavigationManagerClass.OnBeforeNavigateToSymbol(Microsoft.VisualStudio.Shell.Interop.IVsHierarchy,System.UInt32,System.String,System.Int32) 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.

Return to top
Show: