NavigateToItem Class

NavigateToItem Class

Represents a single symbol, and holds the information that is required to order symbols.


Namespace:  Microsoft.VisualStudio.Language.NavigateTo.Interfaces
Assembly:  Microsoft.VisualStudio.Language.NavigateTo.Interfaces (in Microsoft.VisualStudio.Language.NavigateTo.Interfaces.dll)

public sealed class NavigateToItem

The NavigateToItem type exposes the following members.

Public methodNavigateToItemInitializes a new instance of the NavigateToItem class.

Public propertyDisplayFactoryGets UI-appropriate display information for the symbol.
Public propertyKindGets the symbol's kind. The kind is the file, class, method, and so on. It is one of the constants defined in NavigateToItemKind.
Public propertyLanguageGets the language from which the symbol comes.
Public propertyMatchKindGets the MatchKind member that indicates how the symbol matches the search string.
Public propertyNameGets the name of the symbol.
Public propertySecondarySortGets the arbitrary string that is used to sort symbols that are otherwise equivalent.
Public propertyTagGets the custom data that the implementer provided.

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 a hash function for a particular type. (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 methodToStringReturns a string that represents the current object. (Inherited from Object.)

Symbols are sorted in the following order:

  1. matchKind (exact, prefix, or regular).

  2. name.

  3. kind (file, class, method, and so on).

  4. secondarySort, to sort any symbols that are otherwise equivalent.

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

Community Additions

© 2016 Microsoft