Cursor Класс

Определение

Представляет изображение, используемое для рисования указателя мыши.Represents the image used to paint the mouse pointer.

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
type Cursor = class
    interface IDisposable
    interface ISerializable
Public NotInheritable Class Cursor
Implements IDisposable, ISerializable
Наследование
Cursor
Атрибуты
Реализации

Примеры

В следующем примере кода выводится форма, демонстрирующая использование пользовательского курсора.The following code example displays a form that demonstrates using a custom cursor. Пользовательский Cursor внедряется в файл ресурсов приложения.The custom Cursor is embedded in the application's resource file. В примере необходим курсор, содержащийся в файле курсора с именем MyCursor.cur.The example requires a cursor contained in a cursor file named MyCursor.cur. Чтобы скомпилировать этот пример с помощью командной строки, включите следующий флаг: /res:MyCursor.Cur, CustomCursor.MyCursor.CurTo compile this example using the command line, include the following flag: /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

В следующем примере кода отображаются сведения о клиенте в элементе управления TreeView.The following code 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. В этом примере 1 000 клиентов отображаются с 15 заказами.In this example, 1,000 customers are displayed with 15 orders each. Перерисовка TreeView подавляется с помощью методов BeginUpdate и EndUpdate, а Cursor ожидания отображается, когда TreeView создает и закрашивает объекты TreeNode.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. В этом примере требуется файл курсора с именем MyWait.cur в каталоге приложения.This example requires that you have a cursor file named MyWait.cur in the application directory. Также требуется объект Customer, который может содержать коллекцию Order объектов и созданный экземпляр элемента управления TreeView на Form.It also requires a Customer object that can hold a collection of Order objects, and that you have created an instance of a TreeView control on a 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

Комментарии

Курсор представляет собой небольшое изображение, положение которого на экране управляется указывающим устройством, например мышью, пером или трекболом.A cursor is a small picture whose location on the screen is controlled by a pointing device, such as a mouse, pen, or trackball. Когда пользователь перемещает указывающее устройство, операционная система соответствующим образом перемещает курсор.When the user moves the pointing device, the operating system moves the cursor accordingly.

Для информирования пользователя о том, какая операция будет иметь мышь, используются разные фигуры курсора.Different cursor shapes are used to inform the user what operation the mouse will have. Например, при редактировании или выделении текста обычно отображается Cursors.IBeam курсор.For example, when editing or selecting text, a Cursors.IBeam cursor is typically displayed. Курсор ожидания обычно используется для информирования пользователя о том, что процесс выполняется в данный момент.A wait cursor is commonly used to inform the user that a process is currently running. Примерами процессов, которые может ожидать пользователь, является открытие файла, сохранение файла или заполнение элемента управления, например DataGrid, ListBox или TreeView с большим объемом данных.Examples of processes you might have the user wait for are opening a file, saving a file, or filling a control such as a DataGrid, ListBox or TreeView with a large amount of data.

Все элементы управления, производные от класса Control, имеют свойство Cursor.All controls that derive from the Control class have a Cursor property. Чтобы изменить курсор, отображаемый указателем мыши в пределах границ элемента управления, назначьте Cursor свойству Cursor элемента управления.To change the cursor displayed by the mouse pointer when it is within the bounds of the control, assign a Cursor to the Cursor property of the control. Кроме того, можно отображать курсоры на уровне приложения, назначив Cursor свойству Current.Alternatively, you can display cursors at the application level by assigning a Cursor to the Current property. Например, если приложение предназначено для редактирования текстового файла, можно задать для свойства Current значение Cursors.WaitCursor, чтобы отобразить курсор ожидания для приложения во время загрузки или сохранения файла, чтобы предотвратить обработку событий мыши.For example, if the purpose of your application is to edit a text file, you might set the Current property to Cursors.WaitCursor to display a wait cursor over the application while the file loads or saves to prevent any mouse events from being processed. По завершении процесса задайте для свойства Current значение Cursors.Default, чтобы приложение отображало соответствующий курсор для каждого типа элемента управления.When the process is complete, set the Current property to Cursors.Default for the application to display the appropriate cursor over each control type.

Примечание

Если вызвать Application.DoEvents перед сбросом свойства Current обратно в Cursors.Default курсор, приложение возобновит прослушивание событий мыши и возобновит отображение соответствующего Cursor для каждого элемента управления в приложении.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.

Объекты Cursor можно создавать из нескольких источников, таких как маркер существующей Cursor, Стандартный Cursor файл, ресурс или поток данных.Cursor objects can be created from several sources, such as the handle of an existing Cursor, a standard Cursor file, a resource, or a data stream.

Примечание

Класс Cursor не поддерживает анимированные курсоры (ANI-файлы) или курсоры с цветами, отличными от черного и белого.The Cursor class does not support animated cursors (.ani files) or cursors with colors other than black and white.

Если изображение, используемое в качестве курсора, слишком мало, можно использовать метод DrawStretched, чтобы заставить изображение заполнять границы курсора.If the image you are using as a cursor is too small, you can use the DrawStretched method to force the image to fill the bounds of the cursor. Можно временно скрыть курсор, вызвав метод Hide и восстановить его, вызвав метод Show.You can temporarily hide the cursor by calling the Hide method, and restore it by calling the Show method.

Начиная с .NET Framework 4.5.2, размер Cursor будет изменен на основе параметра DPI системы, если файл App. config содержит следующую запись:Starting with the .NET Framework 4.5.2, the Cursor will be resized based on the system DPI setting when the app.config file contains the following entry:

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

Конструкторы

Cursor(IntPtr)

Инициализирует новый экземпляр класса Cursor, используя указанный дескриптор Windows.Initializes a new instance of the Cursor class from the specified Windows handle.

Cursor(Stream)

Инициализация нового экземпляра класса Cursor из указанного потока данных.Initializes a new instance of the Cursor class from the specified data stream.

Cursor(String)

Инициализирует новый экземпляр класса Cursor из указанного файла.Initializes a new instance of the Cursor class from the specified file.

Cursor(Type, String)

Инициализирует новый экземпляр класса Cursor из указанного ресурса, используя указанный тип ресурса.Initializes a new instance of the Cursor class from the specified resource with the specified resource type.

Свойства

Clip

Получает или задает границы, представляющие прямоугольник отсечения для курсора.Gets or sets the bounds that represent the clipping rectangle for the cursor.

Current

Получает или задает объект курсора, представляющий указатель мыши.Gets or sets a cursor object that represents the mouse cursor.

Handle

Возвращает дескриптор курсора.Gets the handle of the cursor.

HotSpot

Возвращает гиперзону курсора.Gets the cursor hot spot.

Position

Получает или задает положение курсора.Gets or sets the cursor's position.

Size

Возвращает размер объекта курсора.Gets the size of the cursor object.

Tag

Возвращает или задает объект, содержащий данные об элементе Cursor.Gets or sets the object that contains data about the Cursor.

Методы

CopyHandle()

Копирует дескриптор этого курсора Cursor.Copies the handle of this Cursor.

Dispose()

Освобождает все ресурсы, занятые Cursor.Releases all resources used by the Cursor.

Draw(Graphics, Rectangle)

Рисует курсор на заданной поверхности в пределах указанных границ.Draws the cursor on the specified surface, within the specified bounds.

DrawStretched(Graphics, Rectangle)

Рисует курсор в растянутом формате на указанной поверхности в пределах указанных границ.Draws the cursor in a stretched format on the specified surface, within the specified bounds.

Equals(Object)

Возвращает значение, показывающее, равен ли данный курсор указанному курсору Cursor.Returns a value indicating whether this cursor is equal to the specified Cursor.

Finalize()

Позволяет объекту попытаться освободить ресурсы и выполнить другие операции очистки, перед тем как объект будет утилизирован в процессе сборки мусора.Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

GetHashCode()

Возвращает хэш-код для текущего объекта Cursor.Retrieves the hash code for the current Cursor.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
Hide()

Скрывает курсор.Hides the cursor.

MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
Show()

Отображает курсор.Displays the cursor.

ToString()

Возвращает удобную для восприятия строку, представляющую этот курсор Cursor.Retrieves a human readable string representing this Cursor.

Операторы

Equality(Cursor, Cursor)

Возвращает значение, показывающее, являются ли эквивалентными экземпляры класса Cursor.Returns a value indicating whether two instances of the Cursor class are equal.

Inequality(Cursor, Cursor)

Возвращает значение, показывающее, являются ли два экземпляра класса Cursor неэквивалентными.Returns a value indicating whether two instances of the Cursor class are not equal.

Явные реализации интерфейса

ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Сериализирует объект.Serializes the object.

Применяется к

Дополнительно