INavigateToItemDisplay3 Interface

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Language.NavigateTo.Interfaces
Assembly:
Microsoft.VisualStudio.Language.NavigateTo.Interfaces.dll
Package:
Microsoft.VisualStudio.Language.NavigateTo.Interfaces v17.11.260

Important

This API is not CLS-compliant.

Adds an ability to provide an item's icon as an ImageMoniker and allows the provider to describe the matching characters of an item for complex matching scenarios.

public interface class INavigateToItemDisplay3 : Microsoft::VisualStudio::Language::NavigateTo::Interfaces::INavigateToItemDisplay2
public interface class INavigateToItemDisplay3 : Microsoft::VisualStudio::Language::NavigateTo::Interfaces::INavigateToItemDisplay2
__interface INavigateToItemDisplay3 : Microsoft::VisualStudio::Language::NavigateTo::Interfaces::INavigateToItemDisplay2
[System.CLSCompliant(false)]
public interface INavigateToItemDisplay3 : Microsoft.VisualStudio.Language.NavigateTo.Interfaces.INavigateToItemDisplay2
public interface INavigateToItemDisplay3 : Microsoft.VisualStudio.Language.NavigateTo.Interfaces.INavigateToItemDisplay2
[<System.CLSCompliant(false)>]
type INavigateToItemDisplay3 = interface
    interface INavigateToItemDisplay2
    interface INavigateToItemDisplay
type INavigateToItemDisplay3 = interface
    interface INavigateToItemDisplay2
    interface INavigateToItemDisplay
Public Interface INavigateToItemDisplay3
Implements INavigateToItemDisplay2
Attributes
CLSCompliantAttribute
Implements
INavigateToItemDisplay INavigateToItemDisplay2

Properties

AdditionalInformation

Any additional information that should be displayed for the item. A primary use of this string is to help users differentiate between items with identical names. For example, for types and members this could be the fully qualified name of the symbol.

(Inherited from INavigateToItemDisplay)
Description

Detailed information to be displayed about the item. Commonly this will include the kind, scope, location and a preview of the item.

(Inherited from INavigateToItemDisplay)
DescriptionItems

If this property is provided, a richly formatted display of the description can be achieved than with the plain text Description property.

(Inherited from INavigateToItemDisplay)
Glyph

The symbol glyph. This should be closely associated with the kind Kind to indicate to the user if the item is a class, file, method, etc.

(Inherited from INavigateToItemDisplay)
GlyphMoniker

Gets the item's icon moniker. This should be closely associated with the Kind to indicate to the user if the item is a class, file, method, etc.
Name

The name of the item.

(Inherited from INavigateToItemDisplay)

Methods

GetAdditionalInformationMatchRuns(String)

Gets a list of spans (character positions) of matching (against the search query) character start/stop indexes in the AdditionalInformation property. Return null for the default behavior where the caller tries to figure out the matching characters.
GetNameMatchRuns(String)

Gets a list of spans (character positions) of matching (against the search query) character start/stop indexes in the Name property. Return null for the default behavior where the caller tries to figure out the matching characters.
GetProvisionalViewingStatus()

Determines the provisional viewing status of the item.

(Inherited from INavigateToItemDisplay2)
NavigateTo()

Navigates to the file, line, and column associated with this symbol.

(Inherited from INavigateToItemDisplay)
PreviewItem()

Opens the item in preview mode, without focusing the item. The caller is responsible for setting up a default preview state using NewDocumentStateScope, and the implementation of PreviewItem should only be concerned with opening the correct document.

(Inherited from INavigateToItemDisplay2)

Applies to