IDocumentPeekResult Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Language.Intellisense

Assembly:: Microsoft.VisualStudio.Language.Intellisense.dll

Package:: Microsoft.VisualStudio.Language.Intellisense v17.12.215

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Important

This API is not CLS-compliant.

Represents an IPeekResult that is based on a location in a document.

public interface class IDocumentPeekResult : IDisposable, Microsoft::VisualStudio::Language::Intellisense::IPeekResult

[System.CLSCompliant(false)]
public interface IDocumentPeekResult : IDisposable, Microsoft.VisualStudio.Language.Intellisense.IPeekResult

public interface IDocumentPeekResult : IDisposable, Microsoft.VisualStudio.Language.Intellisense.IPeekResult

[<System.CLSCompliant(false)>]
type IDocumentPeekResult = interface
    interface IPeekResult
    interface IDisposable

type IDocumentPeekResult = interface
    interface IPeekResult
    interface IDisposable

Public Interface IDocumentPeekResult
Implements IDisposable, IPeekResult

Attributes: CLSCompliantAttribute

Implements: IPeekResult IDisposable

Remarks

In a typical scenario Peek service creates IDocumentPeekResult instances representing document based results supplied by Peek providers.

Properties

CanNavigateTo	Determines whether this result has a place to navigate to. (Inherited from IPeekResult)
DesiredEditorGuid	Gets the Guid for the desired editor to open when navigating.
DisplayInfo	Determines properties used for displaying this result to the user. (Inherited from IPeekResult)
DisplayInfo2	Gets the display info that represents the IDocumentPeekResult, which is used to provide more indication on the symbol this IDocumentPeekResult represents.
FilePath	The fully qualified file path identifying the document where the result is located.
IdentifyingSpan	Gets a IPersistentSpan corresponding to the span of the identifying token inside the result location span. For example if this result corresponds to a method, the identifying span is the span of the method name token inside method definition span.
Image	Gets an ImageMoniker representing an image equivalent for the IDocumentPeekResult.
IsReadOnly	Gets whether this result is read-only.
PostNavigationCallback	This function will be called directly after navigation completes (if navigation was successful). (Inherited from IPeekResult)
Span	Gets a IPersistentSpan corresponding to the result location span. For example if this result corresponds to a method, this span is the span of the method definition.

Methods

NavigateTo(Object)

Navigate to the location of this result. If the navigation is succesful, then the PostNavigationCallback will be called.

(Inherited from IPeekResult)

Events

Disposed

Occurs when an IPeekResult is disposed.