Cursor Classe

  • Referência

Definição

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Representa a imagem usada para pintar o ponteiro do mouse.

public ref class Cursor sealed : IDisposable, System::Runtime::Serialization::ISerializable
[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.CursorConverter))]
[System.Serializable]
public sealed class Cursor : IDisposable, System.Runtime.Serialization.ISerializable
[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.CursorConverter))]
public sealed class Cursor : IDisposable, System.Runtime.Serialization.ISerializable
[<System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.CursorConverter))>]
[<System.Serializable>]
type Cursor = class
    interface IDisposable
    interface ISerializable
[<System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.CursorConverter))>]
type Cursor = class
    interface IDisposable
    interface ISerializable
Public NotInheritable Class Cursor
Implements IDisposable, ISerializable
Herança
Object
Cursor
Atributos
TypeConverterAttribute SerializableAttribute
Implementações
IDisposable ISerializable

Exemplos

O exemplo de código a seguir exibe um formulário que demonstra o uso de um cursor personalizado. O personalizado Cursor é inserido no arquivo de recurso do aplicativo. O exemplo requer um cursor contido em um arquivo de cursor chamado MyCursor.cur. Para compilar este exemplo usando a linha de comando, inclua o seguinte sinalizador: /res:MyCursor.Cur, CustomCursor.MyCursor.Cur

using System;
using System.Drawing;
using System.Windows.Forms;

namespace CustomCursor
{
    public class Form1 : System.Windows.Forms.Form
    {
        [STAThread]
        static void Main() 
        {
            Application.Run(new Form1());
        }

        public Form1()
        {
            this.ClientSize = new System.Drawing.Size(292, 266);
            this.Text = "Cursor Example";
            
            // The following generates a cursor from an embedded resource.
            
            // To add a custom cursor, create a bitmap
            //        1. Add a new cursor file to your project: 
            //                Project->Add New Item->General->Cursor File

            // --- To make the custom cursor an embedded resource  ---
            
            // In Visual Studio:
            //        1. Select the cursor file in the Solution Explorer
            //        2. Choose View->Properties.
            //        3. In the properties window switch "Build Action" to "Embedded Resources"

            // On the command line:
            //        Add the following flag:
            //            /res:CursorFileName.cur,Namespace.CursorFileName.cur
            //        
            //        Where "Namespace" is the namespace in which you want to use the cursor
            //        and   "CursorFileName.cur" is the cursor filename.

            // The following line uses the namespace from the passed-in type
            // and looks for CustomCursor.MyCursor.Cur in the assemblies manifest.
        // NOTE: The cursor name is acase sensitive.
            this.Cursor = new Cursor(GetType(), "MyCursor.cur");  
        }
    }
}

Imports System.Drawing
Imports System.Windows.Forms

Namespace CustomCursor
   
   Public Class Form1
      Inherits System.Windows.Forms.Form
      
      <System.STAThread()> _
      Public Shared Sub Main()
         System.Windows.Forms.Application.Run(New Form1())
      End Sub

      Public Sub New()

         Me.ClientSize = New System.Drawing.Size(292, 266)
         Me.Text = "Cursor Example"
         
        ' The following generates a cursor from an embedded resource.
         
        'To add a custom cursor, create a bitmap
        '       1. Add a new cursor file to your project: 
        '               Project->Add New Item->General->Cursor File

        '--- To make the custom cursor an embedded resource  ---

        'In Visual Studio:
        '       1. Select the cursor file in the Solution Explorer
        '       2. Choose View->Properties.
        '       3. In the properties window switch "Build Action" to "Embedded Resources"

        'On the command line:
        '       Add the following flag:
        '           /res:CursorFileName.cur,Namespace.CursorFileName.cur

        '       Where "Namespace" is the namespace in which you want to use the cursor
        '       and   "CursorFileName.cur" is the cursor filename.

        'The following line uses the namespace from the passed-in type
        'and looks for CustomCursor.MyCursor.cur in the assemblies manifest.
        'NOTE: The cursor name is acase sensitive.
        Me.Cursor = New Cursor(Me.GetType(), "MyCursor.cur")
      End Sub
   End Class
End Namespace 'CustomCursor

O exemplo de código a seguir exibe informações do cliente em um TreeView controle. Os nós de árvore raiz exibem nomes de clientes e os nós de árvore filho exibem os números de pedido atribuídos a cada cliente. Neste exemplo, 1.000 clientes são exibidos com 15 pedidos cada. A repintagem do TreeView é suprimida usando os métodos e EndUpdate os BeginUpdate métodos e uma espera Cursor é exibida enquanto os TreeView cria e pinta os TreeNode objetos. Este exemplo exige que você tenha um arquivo de cursor nomeado MyWait.cur no diretório do aplicativo. Ele também requer um Customer objeto que possa conter uma coleção de Order objetos e que você tenha criado uma instância de um TreeView controle em um Form.

// The basic Customer class.
ref class Customer: public System::Object
{
private:
   String^ custName;

protected:
   ArrayList^ custOrders;

public:
   Customer( String^ customername )
   {
      custName = "";
      custOrders = gcnew ArrayList;
      this->custName = customername;
   }


   property String^ CustomerName 
   {
      String^ get()
      {
         return this->custName;
      }

      void set( String^ value )
      {
         this->custName = value;
      }

   }

   property ArrayList^ CustomerOrders 
   {
      ArrayList^ get()
      {
         return this->custOrders;
      }

   }

};


// End Customer class
// The basic customer Order class.
ref class Order: public System::Object
{
private:
   String^ ordID;

public:
   Order( String^ orderid )
   {
      ordID = "";
      this->ordID = orderid;
   }


   property String^ OrderID 
   {
      String^ get()
      {
         return this->ordID;
      }

      void set( String^ value )
      {
         this->ordID = value;
      }

   }

};
// End Order class



void FillMyTreeView()
{
   // Add customers to the ArrayList of Customer objects.
   for ( int x = 0; x < 1000; x++ )
   {
      customerArray->Add( gcnew Customer( "Customer " + x ) );
   }
   
   // Add orders to each Customer object in the ArrayList.
   IEnumerator^ myEnum = customerArray->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Customer^ customer1 = safe_cast<Customer^>(myEnum->Current);
      for ( int y = 0; y < 15; y++ )
      {
         customer1->CustomerOrders->Add( gcnew Order( "Order " + y ) );
      }
   }

   // Display a wait cursor while the TreeNodes are being created.
   ::Cursor::Current = gcnew System::Windows::Forms::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.
   myEnum = customerArray->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Customer^ customer2 = safe_cast<Customer^>(myEnum->Current);
      treeView1->Nodes->Add( gcnew 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 = safe_cast<Order^>(myEnum->Current);
         treeView1->Nodes[ customerArray->IndexOf( customer2 ) ]->Nodes->Add( gcnew TreeNode( customer2->CustomerName + "." + order1->OrderID ) );
      }
   }
   
   // Reset the cursor to the default for all controls.
   ::Cursor::Current = Cursors::Default;
   
   // Begin repainting the TreeView.
   treeView1->EndUpdate();
}


// The basic Customer class.
public class Customer : System.Object
{
   private string custName = "";
   protected ArrayList custOrders = new ArrayList();

   public Customer(string customername)
   {
      this.custName = customername;
   }

   public string CustomerName
   {      
      get{return this.custName;}
      set{this.custName = value;}
   }

   public ArrayList CustomerOrders 
   {
      get{return this.custOrders;}
   }
} // End Customer class 

// The basic customer Order class.
public class Order : System.Object
{
   private string ordID = "";

   public Order(string orderid)
   {
      this.ordID = orderid;
   }

   public string OrderID
   {      
      get{return this.ordID;}
      set{this.ordID = value;}
   }
} // End Order class

// 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();
}

Public Class Customer
   Inherits [Object]
   Private custName As String = ""
   Friend custOrders As New ArrayList()

   Public Sub New(ByVal customername As String)
      Me.custName = customername
   End Sub

   Public Property CustomerName() As String
      Get
         Return Me.custName
      End Get
      Set(ByVal Value As String)
         Me.custName = Value
      End Set
   End Property

   Public ReadOnly Property CustomerOrders() As ArrayList
      Get
         Return Me.custOrders
      End Get
   End Property
End Class


Public Class Order
   Inherits [Object]
   Private ordID As String

   Public Sub New(ByVal orderid As String)
      Me.ordID = orderid
   End Sub

   Public Property OrderID() As String
      Get
         Return Me.ordID
      End Get
      Set(ByVal Value As String)
         Me.ordID = Value
      End Set
   End Property
End Class

' 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

Comentários

Um cursor é uma imagem pequena cujo local na tela é controlado por um dispositivo pontudo, como um mouse, uma caneta ou um trackball. Quando o usuário move o dispositivo apontando, o sistema operacional move o cursor adequadamente.

Diferentes formas de cursor são usadas para informar ao usuário qual operação o mouse terá. Por exemplo, ao editar ou selecionar texto, um Cursors.IBeam cursor normalmente é exibido. Um cursor de espera é comumente usado para informar ao usuário que um processo está em execução no momento. Exemplos de processos pelos quais você pode ter a espera do usuário estão abrindo um arquivo, salvando um arquivo ou preenchendo um controle, como um DataGrid, ListBox ou TreeView com uma grande quantidade de dados.

Todos os controles que derivam da Control classe têm uma Cursor propriedade. Para alterar o cursor exibido pelo ponteiro do mouse quando ele estiver dentro dos limites do controle, atribua uma Cursor à Cursor propriedade do controle. Como alternativa, você pode exibir cursores no nível do aplicativo atribuindo uma Cursor à Current propriedade. Por exemplo, se a finalidade do aplicativo é editar um arquivo de texto, você pode definir a Current propriedade para Cursors.WaitCursor exibir um cursor de espera sobre o aplicativo enquanto o arquivo é carregado ou salvo para impedir que eventos de mouse sejam processados. Quando o processo for concluído, defina a Current propriedade para Cursors.Default que o aplicativo exiba o cursor apropriado sobre cada tipo de controle.

Observação

Se você chamar Application.DoEvents antes de redefinir a Current propriedade de volta para o Cursors.Default cursor, o aplicativo retomará a escuta de eventos do mouse e continuará exibindo o apropriado Cursor para cada controle no aplicativo.

Objetos de cursor podem ser criados a partir de várias fontes, como o identificador de um arquivo padrão Cursor existenteCursor, um recurso ou um fluxo de dados.

Observação

A Cursor classe não dá suporte a cursores animados (arquivos.ani) ou cursores com cores diferentes de preto e branco.

Se a imagem que você está usando como cursor for muito pequena, você poderá usar o DrawStretched método para forçar a imagem a preencher os limites do cursor. Você pode ocultar temporariamente o cursor chamando o Hide método e restaurá-lo chamando o Show método.

A partir do .NET Framework 4.5.2, ele Cursor será redimensionado com base na configuração de DPI do sistema quando o arquivo app.config contiver a seguinte entrada:

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

Construtores

Cursor(IntPtr)

Inicializa uma nova instância da classe Cursor do manipulador do Windows especificado.
Cursor(Stream)

Inicializa uma nova instância da classe Cursor do fluxo de dados especificado.
Cursor(String)

Inicializa uma nova instância da classe Cursor do arquivo especificado.
Cursor(Type, String)

Inicializa uma nova instância da classe Cursor do recurso especificado com o tipo de recurso especificado.

Propriedades

Clip

Obtém ou define os limites que representam o retângulo de corte para o cursor.
Current

Obtém ou define um objeto de cursor que representa o cursor do mouse.
Handle

Obtém o identificador do cursor.
HotSpot

Obtém o ponto de acesso do cursor.
Position

Obtém ou define a posição do cursor.
Size

Obtém o tamanho do objeto de cursor.
Tag

Obtém ou define o objeto que contém dados sobre o Cursor.

Métodos

CopyHandle()

Copia o identificador deste Cursor.
Dispose()

Libera todos os recursos usados pelo Cursor.
Draw(Graphics, Rectangle)

Desenha o cursor na superfície especificada, dentro dos limites especificados.
DrawStretched(Graphics, Rectangle)

Desenha o cursor em um formato ampliado na superfície especificada, dentro dos limites especificados.
Equals(Object)

Retorna um valor que indica se esse cursor é igual ao Cursor especificado.
Finalize()

Permite que um objeto tente liberar recursos e executar outras operações de limpeza antes de ser recuperado pela coleta de lixo.
GetHashCode()

Recupera o código hash para o Cursor atual.
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
Hide()

Oculta o cursor.
MemberwiseClone()

Cria uma cópia superficial do Object atual.

(Herdado de Object)
Show()

Exibe o cursor.
ToString()

Recupera uma cadeia de caracteres legível por humanos representando esse Cursor.

Operadores

Equality(Cursor, Cursor)

Retorna um valor que indica se duas instâncias da classe Cursor são iguais.
Inequality(Cursor, Cursor)

Retorna um valor que indica se duas instâncias da classe Cursor não são iguais.

Implantações explícitas de interface

ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Serializa o objeto.

Aplica-se a

Confira também