Cursor Класс

Определение

Пространство имен:

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Исходный код:

Cursor.cs

Представляет изображение, используемое для рисования указателя мыши.

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

Наследование

Object

Cursor

Атрибуты

TypeConverterAttribute

Реализации

IDisposable ISerializable

Примеры

В следующем примере кода отображается форма, демонстрирующая использование пользовательского курсора. Пользователь Cursor внедряется в файл ресурсов приложения. В примере требуется курсор, содержащийся в файле курсора с именем MyCursor.cur. Чтобы скомпилировать этот пример с помощью командной строки, включите следующий флаг: /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 управления. Узлы корневого дерева отображают имена клиентов, а дочерние узлы дерева отображают номера заказов, назначенные каждому клиенту. В этом примере 1000 клиентов отображаются с 15 заказами. Повторное заполнение TreeView подавляется с помощью BeginUpdate методов и EndUpdate методов, а ожидание Cursor отображается во время TreeView создания и рисования TreeNode объектов. В этом примере требуется, чтобы файл курсора был назван MyWait.cur в каталоге приложения. Для этого также требуется Customer объект, который может содержать коллекцию Order объектов, и что вы создали экземпляр TreeView элемента управления на объекте 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

Комментарии

Курсор — это небольшой рисунок, расположение которого на экране управляется указательным устройством, например мышью, пером или трекболом. Когда пользователь перемещает указывающее устройство, операционная система перемещает курсор соответствующим образом.

Различные фигуры курсора используются для информирования пользователя о том, какая операция будет иметь мышь. Например, при редактировании или выборе текста Cursors.IBeam курсор обычно отображается. Курсор ожидания обычно используется для информирования пользователя о том, что в данный момент выполняется процесс. Примеры процессов, которые могут потребоваться, когда пользователь ожидает открытия файла, сохранения файла или заполнения элемента управления, ListBox например элемента DataGridуправления, или TreeView большого объема данных.

Все элементы управления, производные Control от класса, имеют Cursor свойство. Чтобы изменить курсор, отображаемый указателем мыши, когда он находится в пределах элемента управления, назначьте CursorCursor свойство элемента управления. Кроме того, курсоры можно отобразить на уровне приложения, назначив Cursor свойству Current . Например, если приложение предназначено для редактирования текстового файла, можно задать Current свойство для Cursors.WaitCursor отображения курсора ожидания над приложением во время загрузки или сохранения файла, чтобы предотвратить обработку событий мыши. После завершения процесса задайте Current для приложения значение свойства Cursors.Default , чтобы отобразить соответствующий курсор над каждым типом элемента управления.

Замечание

При вызове Application.DoEvents перед сбросом Current свойства обратно на Cursors.Default курсор приложение возобновляет прослушивание событий мыши и возобновляет отображение соответствующего Cursor элемента управления в приложении.

Объекты курсоров можно создавать из нескольких источников, таких как дескриптор существующего Cursor, стандартного Cursor файла, ресурса или потока данных.

Замечание

Класс Cursor не поддерживает анимированные курсоры (.ani файлы) или курсоры с цветами, отличными от черного и белого.

Если изображение, используемое в качестве курсора, слишком мало, можно использовать DrawStretched метод, чтобы принудительно заполнить границы курсора. Вы можете временно скрыть курсор, Hide вызвав метод, и восстановить его, вызвав Show метод.

Начиная с .NET Framework 4.5.2, Cursor размер будет изменен на основе параметра DPI системы, если файл app.config содержит следующую запись:

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

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

Имя	Описание
Cursor(IntPtr)	Инициализирует новый экземпляр класса из указанного Cursor дескриптора Windows.
Cursor(Stream)	Инициализирует новый экземпляр класса из указанного Cursor потока данных.
Cursor(String)	Инициализирует новый экземпляр класса из указанного Cursor файла.
Cursor(Type, String)	Инициализирует новый экземпляр класса из указанного Cursor ресурса с указанным типом ресурса.

Свойства

Имя	Описание
Clip	Возвращает или задает границы, представляющие прямоугольник обрезки для курсора.
Current	Возвращает или задает объект курсора, представляющий курсор мыши.
Handle	Возвращает дескриптор курсора.
HotSpot	Возвращает горячую точку курсора.
Position	Возвращает или задает позицию курсора.
Size	Возвращает размер объекта курсора.
Tag	Возвращает или задает объект, содержащий данные о объекте Cursor.

Методы

Имя	Описание
CopyHandle()	Копирует дескриптор этого Cursor.
Dispose()	Освобождает все ресурсы, используемые параметром Cursor.
Draw(Graphics, Rectangle)	Рисует курсор на указанной поверхности в пределах указанных границ.
DrawStretched(Graphics, Rectangle)	Рисует курсор в растянутом формате на указанной поверхности в пределах указанных границ.
Equals(Object)	Возвращает значение, указывающее, равен ли этот курсор указанному объекту Cursor.
Finalize()	Позволяет объекту пытаться освободить ресурсы и выполнять другие операции очистки перед его восстановлением сборкой мусора.
GetHashCode()	Извлекает хэш-код для текущего Cursor.
Hide()	Скрывает курсор.
Show()	Отображает курсор.
ToString()	Извлекает удобочитаемую строку, представляющую это Cursor.

Операторы

Имя	Описание
Equality(Cursor, Cursor)	Возвращает значение, указывающее, равны ли два экземпляра Cursor класса.
Inequality(Cursor, Cursor)	Возвращает значение, указывающее, равны ли два экземпляра Cursor класса.

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

Имя	Описание
ISerializable.GetObjectData(SerializationInfo, StreamingContext)	Сериализует объект.

См. также раздел

• Cursors