Export (0) Print
Expand All

Cursor.Current Property

Gets or sets a cursor object that represents the mouse cursor.

[Visual Basic]
Public Shared Property Current As Cursor
[C#]
public static Cursor Current {get; set;}
[C++]
public: __property static Cursor* get_Current();
public: __property static void set_Current(Cursor*);
[JScript]
public static function get Current() : Cursor;
public static function set Current(Cursor);

Property Value

A Cursor that represents the mouse cursor. The default is a null reference (Nothing in Visual Basic) if the mouse cursor is not visible.

Remarks

Setting the Current property changes the cursor currently displayed, and the application stops listening for mouse events. For example, you might set the Current property to Cursors.WaitCursor before you start filling a TreeView, DataGrid, or ListBox control with a large amount of data. After the loop is completed, set this property back to Cursors.Default to display the appropriate cursor for each control.

Note   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.

Example

[Visual Basic, C#, C++] The following 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 assumes you have a cursor file named MyWait.cur in the application directory. It also assumes you have a Customer object that can hold a collection of Order objects. It also assumes that you have created an instance of a TreeView control on a Form.

[Visual Basic] 
' Create a new ArrayList to hold the Customer objects.
Private customerArray As New ArrayList()

Private Sub FillMyTreeView()
   ' Add customers to the ArrayList of Customer objects.
   Dim x As Integer
   For x = 0 To 999
      customerArray.Add(New Customer("Customer" + x.ToString()))
   Next x

   ' Add orders to each Customer object in the ArrayList.
   Dim customer1 As Customer
   For Each customer1 In customerArray
      Dim y As Integer
      For y = 0 To 14
         customer1.CustomerOrders.Add(New Order("Order" + y.ToString()))
      Next y
   Next customer1

   ' Display a wait cursor while the TreeNodes are being created.
   Cursor.Current = New Cursor("MyWait.cur")

   ' Suppress repainting the TreeView until all the objects have been created.
   treeView1.BeginUpdate()

   ' Clear the TreeView each time the method is called.
   treeView1.Nodes.Clear()

   ' Add a root TreeNode for each Customer object in the ArrayList.
   Dim customer2 As Customer
   For Each customer2 In customerArray
      treeView1.Nodes.Add(New TreeNode(customer2.CustomerName))

      ' Add a child TreeNode for each Order object in the current Customer object.
      Dim order1 As Order
      For Each order1 In customer2.CustomerOrders
         treeView1.Nodes(customerArray.IndexOf(customer2)).Nodes.Add( _
    New TreeNode(customer2.CustomerName + "." + order1.OrderID))
      Next order1
   Next customer2

   ' Reset the cursor to the default for all controls.
   Cursor.Current = System.Windows.Forms.Cursors.Default

   ' Begin repainting the TreeView.
   treeView1.EndUpdate()
End Sub 'FillMyTreeView

[C#] 
// Create a new ArrayList to hold the Customer objects.
private ArrayList customerArray = new ArrayList(); 

private void FillMyTreeView()
{
   // Add customers to the ArrayList of Customer objects.
   for(int x=0; x<1000; x++)
   {
      customerArray.Add(new Customer("Customer" + x.ToString()));
   }

   // Add orders to each Customer object in the ArrayList.
   foreach(Customer customer1 in customerArray)
   {
      for(int y=0; y<15; y++)
      {
         customer1.CustomerOrders.Add(new Order("Order" + y.ToString()));    
      }
   }

   // Display a wait cursor while the TreeNodes are being created.
   Cursor.Current = new Cursor("MyWait.cur");
        
   // Suppress repainting the TreeView until all the objects have been created.
   treeView1.BeginUpdate();

   // Clear the TreeView each time the method is called.
   treeView1.Nodes.Clear();

   // Add a root TreeNode for each Customer object in the ArrayList.
   foreach(Customer customer2 in customerArray)
   {
      treeView1.Nodes.Add(new TreeNode(customer2.CustomerName));
          
      // Add a child treenode for each Order object in the current Customer object.
      foreach(Order order1 in customer2.CustomerOrders)
      {
         treeView1.Nodes[customerArray.IndexOf(customer2)].Nodes.Add(
           new TreeNode(customer2.CustomerName + "." + order1.OrderID));
      }
   }

   // Reset the cursor to the default for all controls.
   Cursor.Current = Cursors.Default;

   // Begin repainting the TreeView.
   treeView1.EndUpdate();
}

[C++] 
void FillMyTreeView() {
    // Add customers to the ArrayList of Customer objects.
    for (int x=0; x<1000; x++) {
        customerArray->Add(new Customer(String::Concat(S"Customer ", __box(x))));
    }

    // Add orders to each Customer object in the ArrayList.
    IEnumerator* myEnum = customerArray->GetEnumerator();
    while (myEnum->MoveNext()) {
        Customer* customer1 = __try_cast<Customer*>(myEnum->Current);

        for (int y=0; y<15; y++) {
            customer1->CustomerOrders->Add(new Order(String::Concat(S"Order ", __box(y))));
        }
    }

    // Display a wait cursor while the TreeNodes are being created.
    Cursor::Current = new System::Windows::Forms::Cursor(S"MyWait.cur");

    // Suppress repainting the TreeView until all the objects have been created.
    treeView1->BeginUpdate();

    // Clear the TreeView each time the method is called.
    treeView1->Nodes->Clear();

    // Add a root TreeNode for each Customer object in the ArrayList.
    while (myEnum->MoveNext()) {
        Customer* customer2 = __try_cast<Customer*>(myEnum->Current);

        treeView1->Nodes->Add(new TreeNode(customer2->CustomerName));

        // Add a child treenode for each Order object in the current Customer object.
        IEnumerator* myEnum = customer2->CustomerOrders->GetEnumerator();
        while (myEnum->MoveNext()) {
            Order* order1 = __try_cast<Order*>(myEnum->Current);

            treeView1->Nodes->Item[customerArray->IndexOf(customer2)]->Nodes->Add(
                new TreeNode(String::Concat(customer2->CustomerName, S".", order1->OrderID)));
        }
    }

    // Reset the cursor to the default for all controls.
    Cursor::Current = Cursors::Default;

    // Begin repainting the TreeView.
    treeView1->EndUpdate();
}

[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 Compact Framework

.NET Framework Security: 

See Also

Cursor Class | Cursor Members | System.Windows.Forms Namespace | DoEvents

Show:
© 2014 Microsoft