AbstractUIThreadOperationContext Class

Definition

Namespace:

Microsoft.VisualStudio.Utilities

Assembly:

Microsoft.VisualStudio.Text.UI.dll

Package:

Microsoft.VisualStudio.Text.UI v17.12.215

Abstract base implementation of the IUIThreadOperationContext interface.

public ref class AbstractUIThreadOperationContext abstract : IDisposable, Microsoft::VisualStudio::Utilities::IPropertyOwner, Microsoft::VisualStudio::Utilities::IUIThreadOperationContext

public abstract class AbstractUIThreadOperationContext : IDisposable, Microsoft.VisualStudio.Utilities.IPropertyOwner, Microsoft.VisualStudio.Utilities.IUIThreadOperationContext

type AbstractUIThreadOperationContext = class
    interface IUIThreadOperationContext
    interface IPropertyOwner
    interface IDisposable

Public MustInherit Class AbstractUIThreadOperationContext
Implements IDisposable, IPropertyOwner, IUIThreadOperationContext

Inheritance

Object

AbstractUIThreadOperationContext

Implements

IPropertyOwner IUIThreadOperationContext IDisposable

Constructors

AbstractUIThreadOperationContext(Boolean, String)

Creates a new instance of the AbstractUIThreadOperationContext.

Properties

AllowCancellation	Gets whether the operation can be cancelled.
CompletedItems
Description	Gets user readable operation description, composed of initial context description or descriptions of all currently added scopes.
Properties	A collection of properties.
Scopes	Gets current list of IUIThreadOperationScopes in this context.
TotalItems
UserCancellationToken	Cancellation token for cancelling the operation.

Methods

AddScope(Boolean, String)	Adds an UI thread operation scope with its own cancellability, description and progress tracker. The scope is removed from the context on dispose.
Dispose()	Disposes this instance.
OnScopeChanged(IUIThreadOperationScope)
OnScopeDisposed(IUIThreadOperationScope)
OnScopeProgressChanged(IUIThreadOperationScope)
OnScopesChanged()	Invoked when new IUIThreadOperationScopes are added or disposed.
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.