RemoteUserControl.IRemoteProxiedUserControl.GetObjectAsync Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Extensibility.UI

Assembly:: Microsoft.VisualStudio.Extensibility.Framework.dll

Package:: Microsoft.VisualStudio.Extensibility.Framework v17.12.2051

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.

This method allows querying for the value of a uniquely identifiable object that is part of the DataContext of the control. The value of the object will be sent to the client using ObjectValueNotificationAsync(MessagePackFragment, CancellationToken).

System.Threading.Tasks.Task<bool> IRemoteProxiedUserControl.GetObjectAsync (Microsoft.VisualStudio.RpcContracts.RemoteUI.ObjectId id, System.Threading.CancellationToken cancellationToken);

abstract member Microsoft.VisualStudio.RpcContracts.RemoteUI.IRemoteProxiedUserControl.GetObjectAsync : Microsoft.VisualStudio.RpcContracts.RemoteUI.ObjectId * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
override this.Microsoft.VisualStudio.RpcContracts.RemoteUI.IRemoteProxiedUserControl.GetObjectAsync : Microsoft.VisualStudio.RpcContracts.RemoteUI.ObjectId * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

Function GetObjectAsync (id As ObjectId, cancellationToken As CancellationToken) As Task(Of Boolean) Implements IRemoteProxiedUserControl.GetObjectAsync

Parameters

id: ObjectId

The unique identifier of the object to return.

cancellationToken: CancellationToken

Cancellation token for the async call.

Returns

Task<Boolean>

Whether the object was found. If the result is true, IRemoteProxiedUserControl will call ObjectValueNotificationAsync(MessagePackFragment, CancellationToken) providing a value for the object.

Implements

GetObjectAsync(ObjectId, CancellationToken)

Applies to

Share via