INavigateToItemDisplay2 Interface

Definition

Namespace:

Microsoft.VisualStudio.Language.NavigateTo.Interfaces

Assembly:

Microsoft.VisualStudio.Language.NavigateTo.Interfaces.dll

Package:

Microsoft.VisualStudio.Language.NavigateTo.Interfaces v17.12.215

Adds an optional preview behavior for INavigateToItemDisplay implementations. Implementing INavigateToItemDisplay2 marks the display item as one that supports previewing.

public interface class INavigateToItemDisplay2 : Microsoft::VisualStudio::Language::NavigateTo::Interfaces::INavigateToItemDisplay

public interface class INavigateToItemDisplay2 : Microsoft::VisualStudio::Language::NavigateTo::Interfaces::INavigateToItemDisplay

__interface INavigateToItemDisplay2 : Microsoft::VisualStudio::Language::NavigateTo::Interfaces::INavigateToItemDisplay

public interface INavigateToItemDisplay2 : Microsoft.VisualStudio.Language.NavigateTo.Interfaces.INavigateToItemDisplay

type INavigateToItemDisplay2 = interface
    interface INavigateToItemDisplay

Public Interface INavigateToItemDisplay2
Implements INavigateToItemDisplay

Derived

Microsoft.VisualStudio.Language.NavigateTo.Interfaces.INavigateToItemDisplay3

Implements

INavigateToItemDisplay

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)
Name	The name of the item. (Inherited from INavigateToItemDisplay)

Methods

GetProvisionalViewingStatus()	Determines the provisional viewing status of the item.
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.