Share via


NavigateToItem Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Language.NavigateTo.Interfaces.NavigateToItem

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

Syntax

'Declaration
Public NotInheritable Class NavigateToItem
public sealed class NavigateToItem
public ref class NavigateToItem sealed
[<Sealed>]
type NavigateToItem =  class end
public final class NavigateToItem

The NavigateToItem type exposes the following members.

Constructors

  Name Description
Public method NavigateToItem Initializes a new instance of the NavigateToItem class.

Top

Properties

  Name Description
Public property DisplayFactory Gets UI-appropriate display information for the symbol.
Public property Kind Gets the symbol's kind. The kind is the file, class, method, and so on. It is one of the constants defined in NavigateToItemKind.
Public property Language Gets the language from which the symbol comes.
Public property MatchKind Gets the MatchKind member that indicates how the symbol matches the search string.
Public property Name Gets the name of the symbol.
Public property SecondarySort Gets the arbitrary string that is used to sort symbols that are otherwise equivalent.
Public property Tag Gets the custom data that the implementer provided.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

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.

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.

See Also

Reference

Microsoft.VisualStudio.Language.NavigateTo.Interfaces Namespace