SingleTaskIdleManager Class

  • Article

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

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

Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.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
Public method SingleTaskIdleManager Initializes a new instance of the SingleTaskIdleManager class.

Top

Properties

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

Top

Methods

  Name Description
Public method Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from DisposableObject.)
Protected method Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Standard virtual overload for IDisposable pattern. (Inherited from DisposableObject.)
Protected method DisposeManagedResources Unregisters the object from being called on Idle. This method is called when the object is disposed. (Overrides DisposableObject.DisposeManagedResources().)
Protected method DisposeNativeResources Allows derived classes to provide custom dispose handling for native resources. (Inherited from DisposableObject.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from DisposableObject.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method ThrowIfDisposed Throws an ObjectDisposedException if this object has been disposed. (Inherited from DisposableObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

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

Top

Explicit Interface Implementations

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

See Also

Reference

Microsoft.VisualStudio.Shell Namespace