Share via


DebuggerVisualizerProvider.CreateVisualizerAsync Method

Definition

Requests the provider to initiate the visualization of a new target object.

public abstract System.Threading.Tasks.Task<Microsoft.VisualStudio.RpcContracts.RemoteUI.IRemoteUserControl> CreateVisualizerAsync (Microsoft.VisualStudio.Extensibility.DebuggerVisualizers.VisualizerTarget visualizerTarget, System.Threading.CancellationToken cancellationToken);
abstract member CreateVisualizerAsync : Microsoft.VisualStudio.Extensibility.DebuggerVisualizers.VisualizerTarget * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.RpcContracts.RemoteUI.IRemoteUserControl>
Public MustOverride Function CreateVisualizerAsync (visualizerTarget As VisualizerTarget, cancellationToken As CancellationToken) As Task(Of IRemoteUserControl)

Parameters

visualizerTarget
VisualizerTarget

The VisualizerTarget provides information about the target process and object, and can be used to request the data of the target object or replace it.

cancellationToken
CancellationToken

Cancellation token for the async call.

Returns

An IRemoteUserControl that will show the representation of the target object.

Remarks

Before returning from this call, the extender should subscribe to StateChanged.

When the user dismisses the visualizer UI, the IRemoteUserControl will be disposed. The extension can dispose visualizerTarget to remove the visualizer from the Visual Studio UI.

Applies to