IPeekResultFactory.Create Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Language.Intellisense

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

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.

Overloads

Create(IPeekResultDisplayInfo, Action)	Creates an instance of IPeekResult that is not based on a location in a document, but can be browsed externally, for example a metadata class that can only be browsed in Object Browser.
Create(IPeekResultDisplayInfo, String, Span, Int32, Boolean)	Creates an instance of IPeekResult that is based on a location in a document.
Create(IPeekResultDisplayInfo, String, Int32, Int32, Int32, Int32, Int32, Int32)	Creates an instance of IPeekResult that is based on a location in a document.
Create(IPeekResultDisplayInfo, String, Int32, Int32, Int32, Int32, Int32, Int32, Boolean)	Creates an instance of IPeekResult that is based on a location in a document.
Create(IPeekResultDisplayInfo2, ImageMoniker, String, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32)	Creates an instance of IPeekResult that is based on a location in a document.
Create(IPeekResultDisplayInfo2, ImageMoniker, String, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Boolean)	Creates an instance of IPeekResult that is based on a location in a document.
Create(IPeekResultDisplayInfo2, ImageMoniker, String, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Boolean, Guid)	Creates an instance of IPeekResult that is based on a location in a document.
Create(IPeekResultDisplayInfo2, ImageMoniker, String, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Boolean, Guid, Action<IPeekResult, Object,Object>)	Creates an instance of IPeekResult that is based on a location in a document.

Create(IPeekResultDisplayInfo, Action)

Creates an instance of IPeekResult that is not based on a location in a document, but can be browsed externally, for example a metadata class that can only be browsed in Object Browser.

public:
 Microsoft::VisualStudio::Language::Intellisense::IExternallyBrowsablePeekResult ^ Create(Microsoft::VisualStudio::Language::Intellisense::IPeekResultDisplayInfo ^ displayInfo, Action ^ browseAction);

public Microsoft.VisualStudio.Language.Intellisense.IExternallyBrowsablePeekResult Create (Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo displayInfo, Action browseAction);

abstract member Create : Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo * Action -> Microsoft.VisualStudio.Language.Intellisense.IExternallyBrowsablePeekResult

Public Function Create (displayInfo As IPeekResultDisplayInfo, browseAction As Action) As IExternallyBrowsablePeekResult

Parameters

displayInfo: IPeekResultDisplayInfo

Defines properties used for displaying this result to the user.

browseAction: Action

An action to browse the result externally (outside of Peek).

Returns

IExternallyBrowsablePeekResult

A valid instance of the IExternallyBrowsablePeekResult.

Applies to

Create(IPeekResultDisplayInfo, String, Span, Int32, Boolean)

Creates an instance of IPeekResult that is based on a location in a document.

public:
 Microsoft::VisualStudio::Language::Intellisense::IDocumentPeekResult ^ Create(Microsoft::VisualStudio::Language::Intellisense::IPeekResultDisplayInfo ^ displayInfo, System::String ^ filePath, Microsoft::VisualStudio::Text::Span eoiSpan, int idPosition, bool isReadOnly);

public Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult Create (Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo displayInfo, string filePath, Microsoft.VisualStudio.Text.Span eoiSpan, int idPosition, bool isReadOnly);

abstract member Create : Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo * string * Microsoft.VisualStudio.Text.Span * int * bool -> Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult

Public Function Create (displayInfo As IPeekResultDisplayInfo, filePath As String, eoiSpan As Span, idPosition As Integer, isReadOnly As Boolean) As IDocumentPeekResult

Parameters

displayInfo: IPeekResultDisplayInfo

Defines properties used for displaying this result to the user.

filePath: String

The fully qualified file path identifying the document where the result is located.

eoiSpan: Span

Span of the entity of interest as a character offset from the start of the buffer.

idPosition: Int32

Position of the identifying position as a character offset from the start of the buffer.

isReadOnly: Boolean

Defines whether this result is read-only.

Returns

IDocumentPeekResult

A valid instance of the IDocumentPeekResult.

Applies to

Create(IPeekResultDisplayInfo, String, Int32, Int32, Int32, Int32, Int32, Int32)

Creates an instance of IPeekResult that is based on a location in a document.

public:
 Microsoft::VisualStudio::Language::Intellisense::IDocumentPeekResult ^ Create(Microsoft::VisualStudio::Language::Intellisense::IPeekResultDisplayInfo ^ displayInfo, System::String ^ filePath, int startLine, int startIndex, int endLine, int endIndex, int idLine, int idIndex);

public Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult Create (Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo displayInfo, string filePath, int startLine, int startIndex, int endLine, int endIndex, int idLine, int idIndex);

abstract member Create : Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo * string * int * int * int * int * int * int -> Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult

Public Function Create (displayInfo As IPeekResultDisplayInfo, filePath As String, startLine As Integer, startIndex As Integer, endLine As Integer, endIndex As Integer, idLine As Integer, idIndex As Integer) As IDocumentPeekResult

Parameters

displayInfo: IPeekResultDisplayInfo

Defines properties used for displaying this result to the user.

filePath: String

The fully qualified file path identifying the document where the result is located.

startLine: Int32

Line number of the result location's start position.

startIndex: Int32

Character index of the result location's start position.

endLine: Int32

Line number of the result location's end position.

endIndex: Int32

Character index of the result location's end position.

idLine: Int32

Line number of the result's identifying position (e.g a position of method's name token).

idIndex: Int32

Character index of the result's identifying position (e.g a position of method's name token).

Returns

IDocumentPeekResult

A valid instance of the IDocumentPeekResult.

Applies to

Create(IPeekResultDisplayInfo, String, Int32, Int32, Int32, Int32, Int32, Int32, Boolean)

Creates an instance of IPeekResult that is based on a location in a document.

public:
 Microsoft::VisualStudio::Language::Intellisense::IDocumentPeekResult ^ Create(Microsoft::VisualStudio::Language::Intellisense::IPeekResultDisplayInfo ^ displayInfo, System::String ^ filePath, int startLine, int startIndex, int endLine, int endIndex, int idLine, int idIndex, bool isReadOnly);

public Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult Create (Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo displayInfo, string filePath, int startLine, int startIndex, int endLine, int endIndex, int idLine, int idIndex, bool isReadOnly);

abstract member Create : Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo * string * int * int * int * int * int * int * bool -> Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult

Public Function Create (displayInfo As IPeekResultDisplayInfo, filePath As String, startLine As Integer, startIndex As Integer, endLine As Integer, endIndex As Integer, idLine As Integer, idIndex As Integer, isReadOnly As Boolean) As IDocumentPeekResult

Parameters

displayInfo: IPeekResultDisplayInfo

Defines properties used for displaying this result to the user.

filePath: String

The fully qualified file path identifying the document where the result is located.

startLine: Int32

Line number of the result location's start position.

startIndex: Int32

Character index of the result location's start position.

endLine: Int32

Line number of the result location's end position.

endIndex: Int32

Character index of the result location's end position.

idLine: Int32

Line number of the result's identifying position (e.g a position of method's name token).

idIndex: Int32

Character index of the result's identifying position (e.g a position of method's name token).

isReadOnly: Boolean

Defines whether this result is read-only.

Returns

IDocumentPeekResult

A valid instance of the IDocumentPeekResult.

Applies to

Create(IPeekResultDisplayInfo2, ImageMoniker, String, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32)

Creates an instance of IPeekResult that is based on a location in a document.

public:
 Microsoft::VisualStudio::Language::Intellisense::IDocumentPeekResult ^ Create(Microsoft::VisualStudio::Language::Intellisense::IPeekResultDisplayInfo2 ^ displayInfo, Microsoft::VisualStudio::Imaging::Interop::ImageMoniker image, System::String ^ filePath, int startLine, int startIndex, int endLine, int endIndex, int idStartLine, int idStartIndex, int idEndLine, int idEndIndex);

public Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult Create (Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo2 displayInfo, Microsoft.VisualStudio.Imaging.Interop.ImageMoniker image, string filePath, int startLine, int startIndex, int endLine, int endIndex, int idStartLine, int idStartIndex, int idEndLine, int idEndIndex);

abstract member Create : Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo2 * Microsoft.VisualStudio.Imaging.Interop.ImageMoniker * string * int * int * int * int * int * int * int * int -> Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult

Public Function Create (displayInfo As IPeekResultDisplayInfo2, image As ImageMoniker, filePath As String, startLine As Integer, startIndex As Integer, endLine As Integer, endIndex As Integer, idStartLine As Integer, idStartIndex As Integer, idEndLine As Integer, idEndIndex As Integer) As IDocumentPeekResult

Parameters

displayInfo: IPeekResultDisplayInfo2

Defines properties used for displaying this result to the user.

image: ImageMoniker

An image representing the IDocumentPeekResult.

filePath: String

The fully qualified file path identifying the document where the result is located.

startLine: Int32

Line number of the result location's start position.

startIndex: Int32

Character index of the result location's start position.

endLine: Int32

Line number of the result location's end position.

endIndex: Int32

Character index of the result location's end position.

idStartLine: Int32

Line number of the result's identifying span's start position (e.g a position of method's name token).

idStartIndex: Int32

Character index of the result's identifying span's start position (e.g a position of method's name token).

idEndLine: Int32

Line number of the result's identifying span's end position.

idEndIndex: Int32

Character index of the result's identifying span's end position.

Returns

IDocumentPeekResult

A valid instance of the IDocumentPeekResult.

Applies to

Create(IPeekResultDisplayInfo2, ImageMoniker, String, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Boolean)

Creates an instance of IPeekResult that is based on a location in a document.

public:
 Microsoft::VisualStudio::Language::Intellisense::IDocumentPeekResult ^ Create(Microsoft::VisualStudio::Language::Intellisense::IPeekResultDisplayInfo2 ^ displayInfo, Microsoft::VisualStudio::Imaging::Interop::ImageMoniker image, System::String ^ filePath, int startLine, int startIndex, int endLine, int endIndex, int idStartLine, int idStartIndex, int idEndLine, int idEndIndex, bool isReadOnly);

public Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult Create (Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo2 displayInfo, Microsoft.VisualStudio.Imaging.Interop.ImageMoniker image, string filePath, int startLine, int startIndex, int endLine, int endIndex, int idStartLine, int idStartIndex, int idEndLine, int idEndIndex, bool isReadOnly);

abstract member Create : Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo2 * Microsoft.VisualStudio.Imaging.Interop.ImageMoniker * string * int * int * int * int * int * int * int * int * bool -> Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult

Public Function Create (displayInfo As IPeekResultDisplayInfo2, image As ImageMoniker, filePath As String, startLine As Integer, startIndex As Integer, endLine As Integer, endIndex As Integer, idStartLine As Integer, idStartIndex As Integer, idEndLine As Integer, idEndIndex As Integer, isReadOnly As Boolean) As IDocumentPeekResult

Parameters

displayInfo: IPeekResultDisplayInfo2

Defines properties used for displaying this result to the user.

image: ImageMoniker

An image representing the IDocumentPeekResult.

filePath: String

The fully qualified file path identifying the document where the result is located.

startLine: Int32

Line number of the result location's start position.

startIndex: Int32

Character index of the result location's start position.

endLine: Int32

Line number of the result location's end position.

endIndex: Int32

Character index of the result location's end position.

idStartLine: Int32

Line number of the result's identifying span's start position (e.g a position of method's name token).

idStartIndex: Int32

Character index of the result's identifying span's start position (e.g a position of method's name token).

idEndLine: Int32

Line number of the result's identifying span's end position.

idEndIndex: Int32

Character index of the result's identifying span's end position.

isReadOnly: Boolean

Defines whether this result is read-only.

Returns

IDocumentPeekResult

A valid instance of the IDocumentPeekResult.

Applies to

Create(IPeekResultDisplayInfo2, ImageMoniker, String, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Boolean, Guid)

Creates an instance of IPeekResult that is based on a location in a document.

public:
 Microsoft::VisualStudio::Language::Intellisense::IDocumentPeekResult ^ Create(Microsoft::VisualStudio::Language::Intellisense::IPeekResultDisplayInfo2 ^ displayInfo, Microsoft::VisualStudio::Imaging::Interop::ImageMoniker image, System::String ^ filePath, int startLine, int startIndex, int endLine, int endIndex, int idStartLine, int idStartIndex, int idEndLine, int idEndIndex, bool isReadOnly, Guid editorDestination);

public Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult Create (Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo2 displayInfo, Microsoft.VisualStudio.Imaging.Interop.ImageMoniker image, string filePath, int startLine, int startIndex, int endLine, int endIndex, int idStartLine, int idStartIndex, int idEndLine, int idEndIndex, bool isReadOnly, Guid editorDestination);

abstract member Create : Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo2 * Microsoft.VisualStudio.Imaging.Interop.ImageMoniker * string * int * int * int * int * int * int * int * int * bool * Guid -> Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult

Public Function Create (displayInfo As IPeekResultDisplayInfo2, image As ImageMoniker, filePath As String, startLine As Integer, startIndex As Integer, endLine As Integer, endIndex As Integer, idStartLine As Integer, idStartIndex As Integer, idEndLine As Integer, idEndIndex As Integer, isReadOnly As Boolean, editorDestination As Guid) As IDocumentPeekResult

Parameters

displayInfo: IPeekResultDisplayInfo2

Defines properties used for displaying this result to the user.

image: ImageMoniker

An image representing the IDocumentPeekResult.

filePath: String

The fully qualified file path identifying the document where the result is located.

startLine: Int32

Line number of the result location's start position.

startIndex: Int32

Character index of the result location's start position.

endLine: Int32

Line number of the result location's end position.

endIndex: Int32

Character index of the result location's end position.

idStartLine: Int32

Line number of the result's identifying span's start position (e.g a position of method's name token).

idStartIndex: Int32

Character index of the result's identifying span's start position (e.g a position of method's name token).

idEndLine: Int32

Line number of the result's identifying span's end position.

idEndIndex: Int32

Character index of the result's identifying span's end position.

isReadOnly: Boolean

Defines whether this result is read-only.

editorDestination: Guid

A Guid representing the editor the IDocumentPeekResult should navigate to.

Returns

IDocumentPeekResult

A valid instance of the IDocumentPeekResult.

Applies to

Create(IPeekResultDisplayInfo2, ImageMoniker, String, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Boolean, Guid, Action<IPeekResult, Object,Object>)

Creates an instance of IPeekResult that is based on a location in a document.

public:
 Microsoft::VisualStudio::Language::Intellisense::IDocumentPeekResult ^ Create(Microsoft::VisualStudio::Language::Intellisense::IPeekResultDisplayInfo2 ^ displayInfo, Microsoft::VisualStudio::Imaging::Interop::ImageMoniker image, System::String ^ filePath, int startLine, int startIndex, int endLine, int endIndex, int idStartLine, int idStartIndex, int idEndLine, int idEndIndex, bool isReadOnly, Guid editorDestination, Action<Microsoft::VisualStudio::Language::Intellisense::IPeekResult ^, System::Object ^, System::Object ^> ^ postNavigationCallback);

public Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult Create (Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo2 displayInfo, Microsoft.VisualStudio.Imaging.Interop.ImageMoniker image, string filePath, int startLine, int startIndex, int endLine, int endIndex, int idStartLine, int idStartIndex, int idEndLine, int idEndIndex, bool isReadOnly, Guid editorDestination, Action<Microsoft.VisualStudio.Language.Intellisense.IPeekResult,object,object> postNavigationCallback);

abstract member Create : Microsoft.VisualStudio.Language.Intellisense.IPeekResultDisplayInfo2 * Microsoft.VisualStudio.Imaging.Interop.ImageMoniker * string * int * int * int * int * int * int * int * int * bool * Guid * Action<Microsoft.VisualStudio.Language.Intellisense.IPeekResult, obj, obj> -> Microsoft.VisualStudio.Language.Intellisense.IDocumentPeekResult

Public Function Create (displayInfo As IPeekResultDisplayInfo2, image As ImageMoniker, filePath As String, startLine As Integer, startIndex As Integer, endLine As Integer, endIndex As Integer, idStartLine As Integer, idStartIndex As Integer, idEndLine As Integer, idEndIndex As Integer, isReadOnly As Boolean, editorDestination As Guid, postNavigationCallback As Action(Of IPeekResult, Object, Object)) As IDocumentPeekResult

Parameters

displayInfo: IPeekResultDisplayInfo2

Defines properties used for displaying this result to the user.

image: ImageMoniker

An image representing the IDocumentPeekResult.

filePath: String

The fully qualified file path identifying the document where the result is located.

startLine: Int32

Line number of the result location's start position.

startIndex: Int32

Character index of the result location's start position.

endLine: Int32

Line number of the result location's end position.

endIndex: Int32

Character index of the result location's end position.

idStartLine: Int32

Line number of the result's identifying span's start position (e.g a position of method's name token).

idStartIndex: Int32

Character index of the result's identifying span's start position (e.g a position of method's name token).

idEndLine: Int32

Line number of the result's identifying span's end position.

idEndIndex: Int32

Character index of the result's identifying span's end position.

isReadOnly: Boolean

Defines whether this result is read-only.

editorDestination: Guid

A Guid representing the editor the IDocumentPeekResult should navigate to.

postNavigationCallback: Action<IPeekResult,Object,Object>

Pass in a callback function to the IPeekResult.

Returns

IDocumentPeekResult

A valid instance of the IDocumentPeekResult.

Applies to

IPeekResultFactory.Create Method

Definition

Overloads

Create(IPeekResultDisplayInfo, Action)

Parameters

Returns

Applies to

Create(IPeekResultDisplayInfo, String, Span, Int32, Boolean)

Parameters

Returns

Applies to

Create(IPeekResultDisplayInfo, String, Int32, Int32, Int32, Int32, Int32, Int32)

Parameters

Returns

Applies to

Create(IPeekResultDisplayInfo, String, Int32, Int32, Int32, Int32, Int32, Int32, Boolean)

Parameters

Returns

Applies to

Create(IPeekResultDisplayInfo2, ImageMoniker, String, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32)

Parameters

Returns

Applies to

Create(IPeekResultDisplayInfo2, ImageMoniker, String, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Boolean)

Parameters

Returns

Applies to

Create(IPeekResultDisplayInfo2, ImageMoniker, String, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Boolean, Guid)

Parameters

Returns

Applies to

Create(IPeekResultDisplayInfo2, ImageMoniker, String, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Boolean, Guid, Action<IPeekResult, Object,Object>)

Parameters

Returns

Applies to

Additional resources