Share via


IRemoteProxiedUserControl.SetObjectPropertyAsync Method

Definition

This method updates a property of an object that is part of the DataContext of the control.

public System.Threading.Tasks.Task<bool> SetObjectPropertyAsync (Microsoft.VisualStudio.RpcContracts.RemoteUI.ObjectId id, string propertyName, Microsoft.VisualStudio.RpcContracts.RemoteUI.MessagePackFragment value, System.Threading.CancellationToken cancellationToken);
abstract member SetObjectPropertyAsync : Microsoft.VisualStudio.RpcContracts.RemoteUI.ObjectId * string * Microsoft.VisualStudio.RpcContracts.RemoteUI.MessagePackFragment * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
Public Function SetObjectPropertyAsync (id As ObjectId, propertyName As String, value As MessagePackFragment, cancellationToken As CancellationToken) As Task(Of Boolean)

Parameters

id
ObjectId

The unique identifier of the object to update.

propertyName
String

The name of the property to update.

value
MessagePackFragment

The new value to assign.

cancellationToken
CancellationToken

Cancellation token for the async call.

Returns

false if it is not possible to find an object identified by id, true otherwise.

Exceptions

When propertyName is not a valid property for the object identified by id.

Applies to