Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Cursor Class

Represents the image used to paint the mouse pointer.

System.Object
  System.Windows.Forms.Cursor

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

[<Sealed>]
[<SerializableAttribute>]
[<TypeConverterAttribute(typeof(CursorConverter))>]
type Cursor =  
    class 
        interface IDisposable 
        interface ISerializable 
    end

The Cursor type exposes the following members.

  NameDescription
Public methodCursor(IntPtr)Initializes a new instance of the Cursor class from the specified Windows handle.
Public methodCursor(Stream)Initializes a new instance of the Cursor class from the specified data stream.
Public methodCursor(String)Initializes a new instance of the Cursor class from the specified file.
Public methodCursor(Type, String)Initializes a new instance of the Cursor class from the specified resource with the specified resource type.
Top

  NameDescription
Public propertyStatic memberClipGets or sets the bounds that represent the clipping rectangle for the cursor.
Public propertyStatic memberCurrentGets or sets a cursor object that represents the mouse cursor.
Public propertyHandleGets the handle of the cursor.
Public propertyHotSpotGets the cursor hot spot.
Public propertyStatic memberPositionGets or sets the cursor's position.
Public propertySizeGets the size of the cursor object.
Public propertyTagGets or sets the object that contains data about the Cursor.
Top

  NameDescription
Public methodCopyHandleCopies the handle of this Cursor.
Public methodDisposeReleases all resources used by the Cursor.
Public methodDrawDraws the cursor on the specified surface, within the specified bounds.
Public methodDrawStretchedDraws the cursor in a stretched format on the specified surface, within the specified bounds.
Public methodEqualsReturns a value indicating whether this cursor is equal to the specified Cursor. (Overrides Object.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Overrides Object.Finalize().)
Public methodGetHashCodeRetrieves the hash code for the current Cursor. (Overrides Object.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodStatic memberHideHides the cursor.
Public methodStatic memberShowDisplays the cursor.
Public methodToStringRetrieves a human readable string representing this Cursor. (Overrides Object.ToString().)
Top

  NameDescription
Public operatorStatic memberEqualityReturns a value indicating whether two instances of the Cursor class are equal.
Public operatorStatic memberInequalityReturns a value indicating whether two instances of the Cursor class are not equal.
Top

  NameDescription
Explicit interface implemetationPrivate methodISerializable.GetObjectDataInfrastructure. Serializes the object.
Top

A cursor is a small picture whose location on the screen is controlled by a pointing device, such as a mouse, pen, or trackball. When the user moves the pointing device, the operating system moves the cursor accordingly.

Different cursor shapes are used to inform the user what operation the mouse will have. For example, when editing or selecting text, a Cursors.IBeam cursor is typically displayed. A wait cursor is commonly used to inform the user that a process is currently running. Examples of processes you might have the user wait for are opening a file, saving a file, or filling a control such as a DataGrid, ListBox or TreeView with a large amount of data.

All controls that derive from the Control class have a Cursor property. To change the cursor displayed by the mouse pointer when it is within the bounds of the control, assign a Cursor to the Cursor property of the control. Alternatively, you can display cursors at the application level by assigning a Cursor to the Current property. For example, if the purpose of your application is to edit a text file, you might set the Current property to Cursors.WaitCursor to display a wait cursor over the application while the file loads or saves to prevent any mouse events from being processed. When the process is complete, set the Current property to Cursors.Default for the application to display the appropriate cursor over each control type.

NoteNote

If you call Application.DoEvents before resetting the Current property back to the Cursors.Default cursor, the application will resume listening for mouse events and will resume displaying the appropriate Cursor for each control in the application.

Cursor objects can be created from several sources, such as the handle of an existing Cursor, a standard Cursor file, a resource, or a data stream.

NoteNote

The Cursor class does not support animated cursors (.ani files) or cursors with colors other than black and white.

If the image you are using as a cursor is too small, you can use the DrawStretched method to force the image to fill the bounds of the cursor. You can temporarily hide the cursor by calling the Hide method, and restore it by calling the Show method.

Starting with the .NET Framework 4.5.2, the Cursor will be resized based on the system DPI setting when the app.config file contains the following entry:

<appSettings>
  <add key="EnableWindowsFormsHighDpiAutoResizing" value="true" />
</appSettings>

The following code example displays a form that demonstrates using a custom cursor. The custom Cursor is embedded in the application's resource file. The example requires a cursor contained in a cursor file named MyCursor.cur. To compile this example using the command line, include the following flag: /res:MyCursor.Cur, CustomCursor.MyCursor.Cur

No code example is currently available or this language may not be supported.

The following code example displays customer information in a TreeView control. The root tree nodes display customer names, and the child tree nodes display the order numbers assigned to each customer. In this example, 1,000 customers are displayed with 15 orders each. The repainting of the TreeView is suppressed by using the BeginUpdate and EndUpdate methods, and a wait Cursor is displayed while the TreeView creates and paints the TreeNode objects. This example requires that you have a cursor file named MyWait.cur in the application directory. It also requires a Customer object that can hold a collection of Order objects, and that you have created an instance of a TreeView control on a Form.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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