SingleTaskIdleManager Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

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.

Executes a long-running operation at idle priority on the UI thread. To support yielding frequently, the operation should yield return null as frequently as possible to allow the component manager to schedule other tasks and yield to higher-priority operations.

The task will be executed repeatedly until the SingleTaskIdleManager is disposed.

public ref class SingleTaskIdleManager : Microsoft::VisualStudio::PlatformUI::DisposableObject, Microsoft::VisualStudio::OLE::Interop::IOleComponent

[Windows::Foundation::Metadata::WebHostHidden]
class SingleTaskIdleManager : Microsoft::VisualStudio::PlatformUI::DisposableObject, Microsoft::VisualStudio::OLE::Interop::IOleComponent

public class SingleTaskIdleManager : Microsoft.VisualStudio.PlatformUI.DisposableObject, Microsoft.VisualStudio.OLE.Interop.IOleComponent

type SingleTaskIdleManager = class
    inherit DisposableObject
    interface IOleComponent

Public Class SingleTaskIdleManager
Inherits DisposableObject
Implements IOleComponent

Inheritance: Object

DisposableObject
SingleTaskIdleManager

Implements: IOleComponent

Constructors

SingleTaskIdleManager(OnIdleHandler)

Initializes a new instance of the SingleTaskIdleManager class.

Properties

IsDisposed

Returns whether the object has been disposed once, protects against double disposal

(Inherited from DisposableObject)

Methods

Dispose()	Disposes the current object then suppresses further finalization. (Inherited from DisposableObject)
Dispose(Boolean)	Standard virtual overload for IDisposable pattern (Inherited from DisposableObject)
DisposeManagedResources()	Unregisters the object from being called on Idle. This method is called when the object is disposed.
DisposeNativeResources()	Allows derived classes to provide custom dispose handling for native resources (Inherited from DisposableObject)
ThrowIfDisposed()	Throws an ObjectDisposedException if this object has been disposed (Inherited from DisposableObject)

Events

Disposing

Raised when the event is being disposed, while it is still accessible.

(Inherited from DisposableObject)

Explicit Interface Implementations

IOleComponent.FContinueMessageLoop(UInt32, IntPtr, MSG[])	Called during each iteration of a message loop.
IOleComponent.FDoIdle(UInt32)	Gives the component a chance to do idle time tasks.
IOleComponent.FPreTranslateMessage(MSG[])	Processes the message before it is translated and dispatched.
IOleComponent.FQueryTerminate(Int32)	Called when the component manager wishes to know if the component is in a state in which it can terminate.
IOleComponent.FReserved1(UInt32, UInt32, IntPtr, IntPtr)	Reserved.
IOleComponent.HwndGetWindow(UInt32, UInt32)	Gets a window associated with the component.
IOleComponent.OnActivationChange(IOleComponent, Int32, OLECRINFO[], Int32, OLECHOSTINFO[], UInt32)	Notifies the component when a new object is being activated.
IOleComponent.OnAppActivate(Int32, UInt32)	Notifies the component when the host application gains or loses activation.
IOleComponent.OnEnterState(UInt32, Int32)	Notifies the component when the application enters or exits the specified state.
IOleComponent.OnLoseActivation()	Notifies the active component that it has lost its active status because the host or another component has become active.
IOleComponent.Terminate()	Terminates the message loop.

Applies to

Share via