Control Properties


.NET Framework Class Library
Control.Cursor Property

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

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

Syntax

Visual Basic (Declaration)
Public Overridable Property Cursor As Cursor
Visual Basic (Usage)
Dim instance As Control
Dim value As Cursor

value = instance.Cursor

instance.Cursor = value
C#
public virtual Cursor Cursor { get; set; }
C++
public:
virtual property Cursor^ Cursor {
    Cursor^ get ();
    void set (Cursor^ value);
}
J#
/** @property */
public Cursor get_Cursor ()

/** @property */
public void set_Cursor (Cursor value)
JScript
public function get Cursor () : Cursor

public function set Cursor (value : Cursor)

Property Value

A Cursor 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

The following code 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 requires that 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 = safe_cast<String^>(myEnum->Current);
            comboBox1->Items->Add( logicalDrive );
         }
      }
      catch ( Exception^ ex ) 
      {
         MessageBox::Show( ex->Message );
      }
   }
J#
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.set_Cursor(Cursors.get_Hand());
    // Fill the combo box with all the logical 
    // drives available to the user.
    try {
        for (int iCtr = 0; iCtr < Environment.GetLogicalDrives().
            get_Length(); iCtr++) {
            String logicalDrive = Environment.GetLogicalDrives()[iCtr];
            comboBox1.get_Items().Add(logicalDrive);
        }
    }
    catch (System.Exception ex) {
        MessageBox.Show(ex.get_Message());
    }
} //Form1_Load
.NET Framework Security

Platforms

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Framework

Supported in: 2.0, 1.1, 1.0
See Also

Tags :


Page view tracker