IStructureContextSource.GetStructureContextAsync 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.
Gets the context for the given structure tags.
public:
System::Threading::Tasks::Task<System::Object ^> ^ GetStructureContextAsync(System::Collections::Generic::IEnumerable<Microsoft::VisualStudio::Text::UI::Adornments::IStructureElement ^> ^ elements, System::Threading::CancellationToken token);
public System.Threading.Tasks.Task<object> GetStructureContextAsync (System.Collections.Generic.IEnumerable<Microsoft.VisualStudio.Text.UI.Adornments.IStructureElement> elements, System.Threading.CancellationToken token);
abstract member GetStructureContextAsync : seq<Microsoft.VisualStudio.Text.UI.Adornments.IStructureElement> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<obj>
Public Function GetStructureContextAsync (elements As IEnumerable(Of IStructureElement), token As CancellationToken) As Task(Of Object)
Parameters
- elements
- IEnumerable<IStructureElement>
The structure tags to get context for.
- token
- CancellationToken
The cancellation token for this asynchronous method call.
Returns
The object to be displayed in the structure tool tip.
Remarks
If the object returned by this method implements ITextView, ITextView.Close() is called when the tooltip is dismissed.