Cursor Classe

Définition

Espace de noms:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

Cursor.cs

Représente l’image utilisée pour peindre le pointeur de la souris.

public ref class Cursor sealed : 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))>]
type Cursor = class
    interface IDisposable
    interface ISerializable

Public NotInheritable Class Cursor
Implements IDisposable, ISerializable

Héritage

Object

Cursor

Attributs

TypeConverterAttribute

Implémente

IDisposable ISerializable

Exemples

L’exemple de code suivant affiche un formulaire qui illustre l’utilisation d’un curseur personnalisé. La personnalisée Cursor est incorporée dans le fichier de ressources de l’application. L’exemple nécessite un curseur contenu dans un fichier de curseur nommé MyCursor.cur. Pour compiler cet exemple à l’aide de la ligne de commande, incluez l’indicateur suivant : /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

L’exemple de code suivant affiche les informations client dans un TreeView contrôle. Les nœuds d’arborescence racine affichent les noms des clients et les nœuds d’arborescence enfants affichent les numéros de commande attribués à chaque client. Dans cet exemple, 1 000 clients sont affichés avec 15 commandes chacune. La réinitialisation de l’objet TreeView est supprimée à l’aide BeginUpdate des méthodes et EndUpdate des méthodes, et une attente Cursor s’affiche pendant que les TreeView objets sont créés et peints TreeNode . Cet exemple nécessite que vous ayez un fichier de curseur nommé MyWait.cur dans le répertoire de l’application. Il nécessite également un Customer objet qui peut contenir une collection d’objets Order et que vous avez créé une instance d’un TreeView contrôle sur un 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

Remarques

Un curseur est une petite image dont l’emplacement sur l’écran est contrôlé par un appareil pointant, tel qu’une souris, un stylet ou un trackball. Lorsque l’utilisateur déplace l’appareil pointant, le système d’exploitation déplace le curseur en conséquence.

Différentes formes de curseur sont utilisées pour informer l’utilisateur de l’opération que la souris aura. Par exemple, lors de la modification ou de la sélection de texte, un Cursors.IBeam curseur est généralement affiché. Un curseur d’attente est couramment utilisé pour informer l’utilisateur qu’un processus est en cours d’exécution. Voici quelques exemples de processus que l’utilisateur peut attendre pour ouvrir un fichier, enregistrer un fichier ou remplir un contrôle tel qu’un DataGridou TreeViewListBox avec une grande quantité de données.

Tous les contrôles qui dérivent de la Control classe ont une Cursor propriété. Pour modifier le curseur affiché par le pointeur de la souris lorsqu’il se trouve dans les limites du contrôle, affectez une Cursor à la Cursor propriété du contrôle. Vous pouvez également afficher des curseurs au niveau de l’application en affectant une Cursor à la Current propriété. Par exemple, si l’objectif de votre application est de modifier un fichier texte, vous pouvez définir la Current propriété pour Cursors.WaitCursor afficher un curseur d’attente sur l’application pendant que le fichier charge ou enregistre pour empêcher le traitement des événements de souris. Une fois le processus terminé, définissez la Current propriété sur Cursors.Default laquelle l’application doit afficher le curseur approprié sur chaque type de contrôle.

Note

Si vous appelez Application.DoEvents avant de réinitialiser la Current propriété au Cursors.Default curseur, l’application reprend l’écoute des événements de souris et reprend l’affichage approprié Cursor pour chaque contrôle de l’application.

Les objets de curseur peuvent être créés à partir de plusieurs sources, telles que le handle d’un fichier existant Cursor, d’un fichier standard Cursor , d’une ressource ou d’un flux de données.

Note

La Cursor classe ne prend pas en charge les curseurs animés (fichiers .ani) ou les curseurs avec des couleurs autres que le noir et le blanc.

Si l’image que vous utilisez comme curseur est trop petite, vous pouvez utiliser la DrawStretched méthode pour forcer l’image à remplir les limites du curseur. Vous pouvez masquer temporairement le curseur en appelant la Hide méthode et le restaurer en appelant la Show méthode.

À compter du .NET Framework 4.5.2, il Cursor est redimensionné en fonction du paramètre PPP système lorsque le fichier app.config contient l’entrée suivante :

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

Constructeurs

Nom	Description
Cursor(IntPtr)	Initialise une nouvelle instance de la Cursor classe à partir du handle Windows spécifié.
Cursor(Stream)	Initialise une nouvelle instance de la Cursor classe à partir du flux de données spécifié.
Cursor(String)	Initialise une nouvelle instance de la Cursor classe à partir du fichier spécifié.
Cursor(Type, String)	Initialise une nouvelle instance de la Cursor classe à partir de la ressource spécifiée avec le type de ressource spécifié.

Propriétés

Nom	Description
Clip	Obtient ou définit les limites qui représentent le rectangle de découpage du curseur.
Current	Obtient ou définit un objet de curseur qui représente le curseur de la souris.
Handle	Obtient la poignée du curseur.
HotSpot	Obtient le point chaud du curseur.
Position	Obtient ou définit la position du curseur.
Size	Obtient la taille de l’objet de curseur.
Tag	Obtient ou définit l’objet qui contient des données sur le Cursor.

Méthodes

Nom	Description
CopyHandle()	Copie le handle de ce Cursor.
Dispose()	Libère toutes les ressources utilisées par le Cursor.
Draw(Graphics, Rectangle)	Dessine le curseur sur la surface spécifiée, dans les limites spécifiées.
DrawStretched(Graphics, Rectangle)	Dessine le curseur dans un format étendu sur l’aire spécifiée, dans les limites spécifiées.
Equals(Object)	Retourne une valeur indiquant si ce curseur est égal à celui spécifié Cursor.
Finalize()	Permet à un objet d’essayer de libérer des ressources et d’effectuer d’autres opérations de nettoyage avant qu’il ne soit récupéré par garbage collection.
GetHashCode()	Récupère le code de hachage pour le code de hachage actuel Cursor.
Hide()	Masque le curseur.
Show()	Affiche le curseur.
ToString()	Récupère une chaîne lisible humaine représentant ce Cursor.

Opérateurs

Nom	Description
Equality(Cursor, Cursor)	Retourne une valeur indiquant si deux instances de la Cursor classe sont égales.
Inequality(Cursor, Cursor)	Retourne une valeur indiquant si deux instances de la Cursor classe ne sont pas égales.

Implémentations d’interfaces explicites

Nom	Description
ISerializable.GetObjectData(SerializationInfo, StreamingContext)	Sérialise l’objet.

Voir aussi

• Cursors