VsSymbolicNavigationManagerClass Class

Article
04/29/2015

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.

Inheritance Hierarchy

Object
Microsoft.VisualStudio.Shell.Interop.VsSymbolicNavigationManagerClass

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

Syntax

'Declaration
<ClassInterfaceAttribute()> _
<GuidAttribute("3FD6EE6A-1DF2-4305-9946-2146D0E16930")> _
Public Class VsSymbolicNavigationManagerClass _
    Implements IVsSymbolicNavigationManager, VsSymbolicNavigationManager

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

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

[<ClassInterfaceAttribute()>]
[<GuidAttribute("3FD6EE6A-1DF2-4305-9946-2146D0E16930")>]
type VsSymbolicNavigationManagerClass =  
    class 
        interface IVsSymbolicNavigationManager 
        interface VsSymbolicNavigationManager 
    end

public class VsSymbolicNavigationManagerClass implements IVsSymbolicNavigationManager, VsSymbolicNavigationManager

The VsSymbolicNavigationManagerClass type exposes the following members.

Constructors

	Name	Description
	VsSymbolicNavigationManagerClass	Creates a new instance of the VsSymbolicNavigationManagerClass class.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnBeforeNavigateToSymbol	Determines if there is an alternate source file within which to navigate for a specified code symbol (GoTo Definition operation).
	QueryNavigateToSymbol	Retrieves the alternate navigation target for the specified symbol,l if there is one.
	RegisterSymbolicNavigationNotify	Registers the specified IVsSymbolicNavigationManager handler.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnregisterSymbolicNavigationNotify	Unregisters the specified IVsSymbolicNavigationManager handler.

Top

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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Partager via