WaitCursor Class

Article
04/26/2013

Displays the Wait cursor while an instance exists, and restores the original cursor when it is disposed.

Inheritance Hierarchy

Object
Microsoft.VisualStudio.Modeling.Shell.WaitCursor

Namespace: Microsoft.VisualStudio.Modeling.Shell
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll)

Syntax

'Declaration
Public NotInheritable Class WaitCursor _
    Implements IDisposable

public sealed class WaitCursor : IDisposable

public ref class WaitCursor sealed : IDisposable

[<Sealed>]
type WaitCursor =  
    class 
        interface IDisposable 
    end

public final class WaitCursor implements IDisposable

The WaitCursor type exposes the following members.

Constructors

	Name	Description
	WaitCursor	Stores the current cursor and displays the wait cursor whenever the mouse pointer is over the specified user interface control. When the instance is disposed, the current cursor will be restored.

Top

Methods

	Name	Description
	Clear	Restore the original cursor. It is not normally necessary to call this explicitly.
	Dispose	Restore the original cursor. This happens automatically at the end of a using block.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This class is designed to be used with the 'using' statement. In the following example, the wait cursor will be displayed while the enclosed block is being executed, whenever the mouse is over the specified control.

Examples

using (WaitCursor w = new WaitCursor(control)) 
{/* wait cursor displayed over control while execution is in here */}

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.

Share via