IEditorHostService.CreateActiveTextViewAsync Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Extensibility.Editor

Assembly:: Microsoft.VisualStudio.Extensibility.Editor.Contracts.dll

Package:: Microsoft.VisualStudio.Extensibility.Editor.Contracts v17.10.166

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.

Creates a new ITextViewSnapshot from the properties contained in clientContext.

public System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Editor.ITextViewSnapshot?> CreateActiveTextViewAsync (System.Collections.Generic.IReadOnlyDictionary<string,object?> clientContext, System.Threading.CancellationToken cancellationToken);

abstract member CreateActiveTextViewAsync : System.Collections.Generic.IReadOnlyDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Editor.ITextViewSnapshot>

Public Function CreateActiveTextViewAsync (clientContext As IReadOnlyDictionary(Of String, Object), cancellationToken As CancellationToken) As Task(Of ITextViewSnapshot)

Parameters

clientContext: IReadOnlyDictionary<String,Object>

UI properties, including document version (Microsoft.VisualStudio.Extensibility.Framework.IClientContext as dictionary).

cancellationToken: CancellationToken

Cancels the creation action.

Returns

Task<ITextViewSnapshot>

A ITextViewSnapshot thick object that can be used to interact with the editor.

Remarks

This overload is meant primarily for creating ITextViewSnapshots based on properties captured during command invocation.

Applies to

Share via