This documentation is archived and is not being maintained.

Control.Cursor Property

Gets or sets the cursor that is displayed when the mouse pointer is over the control.

[Visual Basic]
Public Overridable Property Cursor As Cursor
[C#]
public virtual Cursor Cursor {get; set;}
[C++]
public: __property virtual Cursor* get_Cursor();
public: __property virtual void set_Cursor(Cursor*);
[JScript]
public function get Cursor() : Cursor;
public function set Cursor(Cursor);

Property Value

A Cursor object that represents the cursor to display when the mouse pointer is over the control.

Remarks

Assign a Cursor to the Cursor property of the control to change the cursor displayed when the mouse pointer is over the control. To temporarily change the mouse cursor for all controls on your application set the Cursor.Current property. Typically you would set the Cursor.Current property to a wait cursor when populating a ComboBox or saving or loading a file.

The Cursor property is an ambient property. An ambient property is a control property that, if not set, is retrieved from the parent control. For example, a Button will have the same BackColor as its parent Form by default. For more information about ambient properties, see the AmbientProperties class or the Control class overview.

Notes to Inheritors:  When overriding the Cursor property in a derived class, use the base class's Cursor property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the get and set methods of the Cursor property; you can override only one if needed.

Example

[Visual Basic, C#, C++] The following example fills a ComboBox with the user's available logical drives. The example also sets the combo box's Cursor property so the Cursors.Hand cursor is displayed when the mouse pointer is over the drop-down button. This code assumes you have a Form with a ComboBox on it.

[Visual Basic] 
Private Sub Form1_Load(sender As Object, _
  e As EventArgs) Handles MyBase.Load
   ' Display the hand cursor when the mouse pointer
   ' is over the combo box drop-down button. 
   comboBox1.Cursor = Cursors.Hand
   
   ' Fill the combo box with all the logical 
   ' drives available to the user. 
   Try
      Dim logicalDrive As String
      For Each logicalDrive In  Environment.GetLogicalDrives()
         comboBox1.Items.Add(logicalDrive)
      Next logicalDrive
   Catch ex As Exception
      MessageBox.Show(ex.Message)
   End Try
End Sub

[C#] 
private void Form1_Load(object sender, EventArgs e)
{
   // Display the hand cursor when the mouse pointer
   // is over the combo box drop-down button. 
   comboBox1.Cursor = Cursors.Hand;

   // Fill the combo box with all the logical 
   // drives available to the user.
   try
   {
      foreach(string logicalDrive in Environment.GetLogicalDrives() )
      {
         comboBox1.Items.Add(logicalDrive);
      }
   }
   catch(Exception ex)
   {
      MessageBox.Show(ex.Message);
   }
}

[C++] 
private:
    void Form1_Load(Object* /*sender*/, EventArgs* /*e*/) {
        // Display the hand cursor when the mouse pointer
        // is over the combo box drop-down button.
        comboBox1->Cursor = Cursors::Hand;

        // Fill the combo box with all the logical
        // drives available to the user.
        try {
            IEnumerator* myEnum = Environment::GetLogicalDrives()->GetEnumerator();
            while (myEnum->MoveNext()) {
                String* logicalDrive = __try_cast<String*>(myEnum->Current);

                comboBox1->Items->Add(logicalDrive);
            }
        } catch (Exception* ex) {
            MessageBox::Show(ex->Message);
        }
    }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

Control Class | Control Members | System.Windows.Forms Namespace | Cursor | Cursors

Show: