IPeekBroker.CreatePeekSession Method
Definition
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
CreatePeekSession(PeekSessionCreationOptions) |
Creates, but does not start a Peek session with the specified options. |
CreatePeekSession(ITextView, ITrackingPoint, String) |
Creates, but does not start a Peek session at a particular position, which is assumed to be the position of a peekable symbol on which a Peek session is requested. |
CreatePeekSession(PeekSessionCreationOptions)
Creates, but does not start a Peek session with the specified options.
public:
Microsoft::VisualStudio::Language::Intellisense::IPeekSession ^ CreatePeekSession(Microsoft::VisualStudio::Language::Intellisense::PeekSessionCreationOptions ^ options);
Microsoft::VisualStudio::Language::Intellisense::IPeekSession CreatePeekSession(Microsoft::VisualStudio::Language::Intellisense::PeekSessionCreationOptions const & options);
public Microsoft.VisualStudio.Language.Intellisense.IPeekSession CreatePeekSession (Microsoft.VisualStudio.Language.Intellisense.PeekSessionCreationOptions options);
abstract member CreatePeekSession : Microsoft.VisualStudio.Language.Intellisense.PeekSessionCreationOptions -> Microsoft.VisualStudio.Language.Intellisense.IPeekSession
Public Function CreatePeekSession (options As PeekSessionCreationOptions) As IPeekSession
Parameters
- options
- PeekSessionCreationOptions
The options needed to create a Peek session.
Returns
A valid Peek session. May be null if no session could be created for the TriggerPoint for the given RelationshipName.
Applies to
CreatePeekSession(ITextView, ITrackingPoint, String)
Creates, but does not start a Peek session at a particular position, which is assumed to be the position of a peekable symbol on which a Peek session is requested.
public:
Microsoft::VisualStudio::Language::Intellisense::IPeekSession ^ CreatePeekSession(Microsoft::VisualStudio::Text::Editor::ITextView ^ textView, Microsoft::VisualStudio::Text::ITrackingPoint ^ triggerPoint, System::String ^ relationshipName);
public:
Microsoft::VisualStudio::Language::Intellisense::IPeekSession ^ CreatePeekSession(Microsoft::VisualStudio::Text::Editor::ITextView ^ textView, Microsoft::VisualStudio::Text::ITrackingPoint ^ triggerPoint, Platform::String ^ relationshipName);
Microsoft::VisualStudio::Language::Intellisense::IPeekSession CreatePeekSession(Microsoft::VisualStudio::Text::Editor::ITextView const & textView, Microsoft::VisualStudio::Text::ITrackingPoint const & triggerPoint, std::wstring const & relationshipName);
public Microsoft.VisualStudio.Language.Intellisense.IPeekSession CreatePeekSession (Microsoft.VisualStudio.Text.Editor.ITextView textView, Microsoft.VisualStudio.Text.ITrackingPoint triggerPoint, string relationshipName);
abstract member CreatePeekSession : Microsoft.VisualStudio.Text.Editor.ITextView * Microsoft.VisualStudio.Text.ITrackingPoint * string -> Microsoft.VisualStudio.Language.Intellisense.IPeekSession
Public Function CreatePeekSession (textView As ITextView, triggerPoint As ITrackingPoint, relationshipName As String) As IPeekSession
Parameters
- triggerPoint
- ITrackingPoint
The point in the text buffer at which a Peek session is requested.
- relationshipName
- String
The name of the requested relationship to be explored by a Peek session.
Returns
A valid Peek session. May be null if no session could be created at the trigger point for the given relationship.