Andy De GeorgeandGenevieve Warren
184e6c9a0c
* Migrate inprogress winforms contnet from docs * Fix preview note * Fix vb code * Minor fixes to keyboard articles * Minor adjustment to overview * Test redirects for 4.0 -> 5.0 * adjust links * Add mouse input section winforms (#81) * Update projects to .NET 5 * Update keyboard desc * Finish mouse events * Add remaining mouse articles;code * finish mouse input * minor fixes * Remove branch restriction (#82) * Update build-validation.yml (#84) * Update build-validation.yml (#85) * Fix vb proj * Add WinForms tutorial (#91) * redirect between overview * New create an app tutorial * Fix markdown * Fix preserve view setting * Add forms articles (#93) * Add forms articles * Fix warnings * Winforms publish (#95) * Prep TOC for publish * Updated date * Automatic how-to topic type * Update desc/headers * Fix links * Fix build errors * Add preview note * Update toc landing page * Convert old style project files * update download links * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Adjust number key * Update dotnet-desktop-guide/net/winforms/overview/index.md * Try toc position task via bookmark * Improve images * Remove sentence * File redirects Co-authored-by: Genevieve Warren <[email protected]>
4.7 KiB
title, description, ms.date, dev_langs, helpviewer_keywords
| title | description | ms.date | dev_langs | helpviewer_keywords | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| How to manage mouse pointer | Learn how to access, control, and change the mouse pointer in Windows Forms for .NET. | 10/26/2020 |
|
|
Manage mouse pointers (Windows Forms .NET)
The mouse pointer, which is sometimes referred to as the cursor, is a bitmap that specifies a focus point on the screen for user input with the mouse. This topic provides an overview of the mouse pointer in Windows Forms and describes some of the ways to modify and control the mouse pointer.
[!INCLUDE desktop guide under construction]
Accessing the mouse pointer
The mouse pointer is represented by the xref:System.Windows.Forms.Cursor class, and each xref:System.Windows.Forms.Control has a xref:System.Windows.Forms.Control.Cursor%2A?displayProperty=nameWithType property that specifies the pointer for that control. The xref:System.Windows.Forms.Cursor class contains properties that describe the pointer, such as the xref:System.Windows.Forms.Cursor.Position%2A and xref:System.Windows.Forms.Cursor.HotSpot%2A properties, and methods that can modify the appearance of the pointer, such as the xref:System.Windows.Forms.Cursor.Show%2A, xref:System.Windows.Forms.Cursor.Hide%2A, and xref:System.Windows.Forms.Cursor.DrawStretched%2A methods.
The following example hides the cursor when the cursor is over a button:
:::code language="csharp" source="snippets/how-to-manage-cursor-pointer/csharp/Form1.cs" id="ShowHideCursor"::: :::code language="vb" source="snippets/how-to-manage-cursor-pointer/vb/Form1.vb" id="ShowHideCursor":::
Controlling the mouse pointer
Sometimes you may want to limit the area in which the mouse pointer can be used or change the position the mouse. You can get or set the current location of the mouse using the xref:System.Windows.Forms.Cursor.Position%2A property of the xref:System.Windows.Forms.Cursor. In addition, you can limit the area the mouse pointer can be used be setting the xref:System.Windows.Forms.Cursor.Clip%2A property. The clip area, by default, is the entire screen.
The following example positions the mouse pointer between two buttons when they are clicked:
:::code language="csharp" source="snippets/how-to-manage-cursor-pointer/csharp/Form1.cs" id="MoveCursor"::: :::code language="vb" source="snippets/how-to-manage-cursor-pointer/vb/Form1.vb" id="MoveCursor":::
Changing the mouse pointer
Changing the mouse pointer is an important way of providing feedback to the user. For example, the mouse pointer can be modified in the handlers of the xref:System.Windows.Forms.Control.MouseEnter and xref:System.Windows.Forms.Control.MouseLeave events to tell the user that computations are occurring and to limit user interaction in the control. Sometimes, the mouse pointer will change because of system events, such as when your application is involved in a drag-and-drop operation.
The primary way to change the mouse pointer is by setting the xref:System.Windows.Forms.Control.Cursor%2A?displayProperty=nameWithType or xref:System.Windows.Forms.Control.DefaultCursor%2A property of a control to a new xref:System.Windows.Forms.Cursor. For examples of changing the mouse pointer, see the code example in the xref:System.Windows.Forms.Cursor class. In addition, the xref:System.Windows.Forms.Cursors class exposes a set of xref:System.Windows.Forms.Cursor objects for many different types of pointers, such as a pointer that resembles a hand.
The following example changes the cursor of the mouse pointer for a button to a hand:
:::code language="csharp" source="snippets/how-to-manage-cursor-pointer/csharp/Form1.cs" id="SetControlCursor"::: :::code language="vb" source="snippets/how-to-manage-cursor-pointer/vb/Form1.vb" id="SetControlCursor":::
To display the wait pointer, which resembles an hourglass, whenever the mouse pointer is on the control, use the xref:System.Windows.Forms.Control.UseWaitCursor%2A property of the xref:System.Windows.Forms.Control class.
See also
- Overview of using the mouse (Windows Forms .NET)
- Using mouse events (Windows Forms .NET)
- How to distinguish between clicks and double-clicks (Windows Forms .NET)
- How to simulate mouse events (Windows Forms .NET)
- xref:System.Windows.Forms.Cursor?displayProperty=nameWithType
- xref:System.Windows.Forms.Cursor.Position%2A?displayProperty=nameWithType