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. この例では、1000の顧客がそれぞれ15の注文と共に表示されます。In this example, 1,000 customers are displayed with 15 orders each. の再TreeView描画は、メソッドBeginUpdateEndUpdateメソッドを使用して抑制され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 カーソルCursors.Defaultに戻す前にCursorを呼び出すと、アプリケーションはマウスイベントのリッスンを再開し、アプリケーション内の各コントロールに適切なを表示します。 CurrentIf 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 以降では、app.config Cursorファイルに次のエントリが含まれている場合、はシステムの DPI 設定に基づいてサイズが変更されます。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)

指定した Windows ハンドルで Cursor クラスの新しいインスタンスを初期化します。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 クラスの 2 つのインスタンスが等しいかどうかを示す値を返します。Returns a value indicating whether two instances of the Cursor class are equal.

Inequality(Cursor, Cursor)

Cursor クラスの 2 つのインスタンスが等しくないかどうかを示す値を返します。Returns a value indicating whether two instances of the Cursor class are not equal.

明示的なインターフェイスの実装

ISerializable.GetObjectData(SerializationInfo, StreamingContext)

オブジェクトをシリアル化します。Serializes the object.

適用対象

こちらもご覧ください