Cursor Classe

Definição

Representa a imagem usada para pintar o ponteiro do rato.

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
Cursor
Atributos
Implementações

Exemplos

O exemplo de código seguinte apresenta um formulário que demonstra o uso de um cursor personalizado. O personalizado Cursor está incorporado no ficheiro de recursos da aplicação. O exemplo requer um cursor contido num ficheiro cursor chamado MyCursor.cur. Para compilar este exemplo usando a linha de comandos, inclua a seguinte bandeira: /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 seguinte exemplo de código mostra a informação do cliente num TreeView controlo. Os nós da árvore raiz mostram os nomes dos clientes, e os nós da árvore filha mostram os números de encomenda atribuídos a cada cliente. Neste exemplo, são exibidos 1.000 clientes com 15 encomendas cada. A repintura do TreeView é suprimida através do uso dos BeginUpdate métodos e, EndUpdate e uma espera Cursor é exibida enquanto cria TreeView e pinta os TreeNode objetos. Este exemplo exige que tenha um ficheiro cursor nomeado MyWait.cur no diretório da aplicação. Também requer um Customer objeto que possa conter uma coleção de Order objetos, e que tenha criado uma instância de um TreeView controlo sobre 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

Observações

Um cursor é uma pequena imagem cuja localização no ecrã é controlada por um dispositivo apontador, como um rato, caneta ou trackball. Quando o utilizador move o dispositivo apontador, o sistema operativo move o cursor em conformidade.

Diferentes formas de cursor são usadas para informar o utilizador sobre a operação que o rato irá realizar. Por exemplo, ao editar ou selecionar texto, normalmente é exibido um Cursors.IBeam cursor. Um cursor de espera é comumente usado para informar o utilizador de que um processo está atualmente a correr. Exemplos de processos que pode fazer o utilizador esperar são abrir um ficheiro, guardar um ficheiro ou preencher um controlo como um DataGrid, ListBox ou TreeView com uma grande quantidade de dados.

Todos os controlos que derivam da Control classe têm uma Cursor propriedade. Para alterar o cursor apresentado pelo ponteiro do rato quando este está dentro dos limites do controlo, atribui a Cursor à Cursor propriedade do controlo. Alternativamente, pode mostrar os cursores ao nível da aplicação atribuindo a Cursor à Current propriedade. Por exemplo, se o objetivo da sua aplicação for editar um ficheiro de texto, pode definir a Current propriedade para Cursors.WaitCursor mostrar um cursor de espera sobre a aplicação enquanto o ficheiro carrega ou guarda, para evitar que eventos do rato sejam processados. Quando o processo estiver concluído, defina a Current propriedade para Cursors.Default que a aplicação mostre o cursor apropriado sobre cada tipo de controlo.

Note

Se chamar Application.DoEvents antes de reiniciar a Current propriedade para o Cursors.Default cursor, a aplicação retomará a escuta dos eventos do rato e retomará a exibição do apropriado Cursor para cada controlo na aplicação.

Os objetos cursor podem ser criados a partir de várias fontes, como o handle de um ficheiro existente Cursor, um ficheiro padrão Cursor , um recurso ou um fluxo de dados.

Note

A Cursor classe não suporta cursores animados (ficheiros .ani) nem cursores com cores diferentes do preto e branco.

Se a imagem que está a usar como cursor for demasiado pequena, pode usar o DrawStretched método para forçar a imagem a preencher os limites do cursor. Pode esconder temporariamente o cursor chamando o Hide método, e restaurá-lo chamando o Show método.

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

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

Construtores

Name Description
Cursor(IntPtr)

Inicializa uma nova instância da classe Cursor a partir do handle de Windows especificado.

Cursor(Stream)

Inicializa uma nova instância da Cursor classe a partir do fluxo de dados especificado.

Cursor(String)

Inicializa uma nova instância da Cursor classe a partir do ficheiro especificado.

Cursor(Type, String)

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

Propriedades

Name Description
Clip

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

Current

Obtém ou define um objeto cursor que representa o cursor do rato.

Handle

Apanha o controlo do cursor.

HotSpot

Fica o ponto quente do cursor.

Position

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

Size

Obtém o tamanho do objeto cursor.

Tag

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

Métodos

Name Description
CopyHandle()

Copia o nome desta Cursor.

Dispose()

Liberta todos os recursos utilizados pelo Cursor.

Draw(Graphics, Rectangle)

Desenha o cursor na superfície especificada, dentro dos limites especificados.

DrawStretched(Graphics, Rectangle)

Desenha o cursor num formato esticado na superfície especificada, dentro dos limites especificados.

Equals(Object)

Devolve um valor que indica se este cursor é igual ao especificado Cursor.

Finalize()

Permite que um objeto tente libertar recursos e realizar outras operações de limpeza antes de ser recuperado pela recolha de lixo.

GetHashCode()

Recupera o código hash para o atual Cursor.

GetType()

Obtém o Type da instância atual.

(Herdado de Object)
Hide()

Esconde o cursor.

MemberwiseClone()

Cria uma cópia superficial do atual Object.

(Herdado de Object)
Show()

Mostra o cursor.

ToString()

Recupera uma cadeia legível humana que representa esta Cursor.

Operadores

Name Description
Equality(Cursor, Cursor)

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

Inequality(Cursor, Cursor)

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

Implementações de Interface Explícita

Name Description
ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Serializa o objeto.

Aplica-se a

Ver também