SingleTaskIdleManager Class

Article
04/29/2015

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

The task is executed repeatedly until SingleTaskIdleManager is disposed.

Inheritance Hierarchy

Object
Microsoft.VisualStudio.PlatformUI.DisposableObject
Microsoft.VisualStudio.Shell.SingleTaskIdleManager

Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)

Syntax

'Declaration
Public Class SingleTaskIdleManager _
    Inherits DisposableObject _
    Implements IOleComponent

public class SingleTaskIdleManager : DisposableObject, 
    IOleComponent

public ref class SingleTaskIdleManager : public DisposableObject, 
    IOleComponent

type SingleTaskIdleManager =  
    class 
        inherit DisposableObject 
        interface IOleComponent 
    end

public class SingleTaskIdleManager extends DisposableObject implements IOleComponent

The SingleTaskIdleManager type exposes the following members.

Constructors

	Name	Description
	SingleTaskIdleManager	Initializes a new instance of the SingleTaskIdleManager class.

Top

Properties

	Name	Description
	IsDisposed	Returns whether the object has been disposed once, which protects against double disposal. (Inherited from DisposableObject.)

Top

Methods

	Name	Description
	Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from DisposableObject.)
	Dispose(Boolean)	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. 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. (Overrides DisposableObject.DisposeManagedResources().)
	DisposeNativeResources	Allows derived classes to provide custom dispose handling for native resources. (Inherited from DisposableObject.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from DisposableObject.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ThrowIfDisposed	Throws an ObjectDisposedException if this object has been disposed. (Inherited from DisposableObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	Disposing	Raised when the event is being disposed, that is, while it is still accessible. (Inherited from DisposableObject.)

Top

Explicit Interface Implementations

	Name	Description
	IOleComponent.FContinueMessageLoop	Called during each iteration of a message loop.
	IOleComponent.FDoIdle	Gives the component a chance to do idle time tasks.
	IOleComponent.FPreTranslateMessage	Processes the message before it is translated and dispatched.
	IOleComponent.FQueryTerminate	Called when the component manager wishes to know if the component is in a state in which it can terminate.
	IOleComponent.FReserved1	Reserved.
	IOleComponent.HwndGetWindow	Gets a window associated with the component.
	IOleComponent.OnActivationChange	Notifies the component when a new object is being activated.
	IOleComponent.OnAppActivate	Notifies the component when the host application gains or loses activation.
	IOleComponent.OnEnterState	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.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Partager via