IUIThreadOperationContext Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Utilities

Assembly:: Microsoft.VisualStudio.Text.UI.dll

Package:: Microsoft.VisualStudio.Text.UI v17.11.260

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.

Represents a context of executing potentially long running operation on the UI thread, which enables shared two way cancellability and wait indication.

public interface class IUIThreadOperationContext : IDisposable, Microsoft::VisualStudio::Utilities::IPropertyOwner

public interface IUIThreadOperationContext : IDisposable, Microsoft.VisualStudio.Utilities.IPropertyOwner

type IUIThreadOperationContext = interface
    interface IPropertyOwner
    interface IDisposable

Public Interface IUIThreadOperationContext
Implements IDisposable, IPropertyOwner

Derived: Microsoft.VisualStudio.Utilities.AbstractUIThreadOperationContext

Implements: IPropertyOwner IDisposable

Remarks

Instances implementing this interface are produced by IUIThreadOperationExecutor MEF component.

Properties

AllowCancellation	Gets whether the operation can be cancelled.
Description	Gets user readable operation description, composed of initial context description and descriptions of all currently added scopes.
Properties	The collection of properties controlled by the property owner. (Inherited from IPropertyOwner)
Scopes	Gets current list of IUIThreadOperationScopes in this context.
UserCancellationToken	Cancellation token that allows user to cancel the operation unless the operation is not cancellable.

Methods

AddScope(Boolean, String)	Adds a UI thread operation scope with its own two way cancellability, description and progress tracker. The scope is removed from the context on dispose.
TakeOwnership()	Allows a component to take full ownership over this UI thread operation, for example when it shows its own modal UI dialog and handles cancellability through that dialog instead.

Applies to

Share via