Share via

InkOverlay.Cursor Property

  • Article

InkOverlay.Cursor Property

Gets or sets the cursor that appears when the mouse pointer is over the InkPicture control.

Definition

Visual Basic .NET Public Property Cursor As Cursor
C# public Cursor Cursor { get; set; }
Managed C++ public: __property Cursor* get_Cursor();
public: __property void set_Cursor(Cursor*);

Property Value

System.Windows.Forms.Cursor. The cursor that appears when the mouse pointer is over the InkPicture control.

This property is read/write. This property has no default value.

Exceptions

COMException Leave Site:
ObjectDisposedException Leave Site:

Remarks

If set to the default cursor, the inherited Default Leave Site property, the behavior of the mouse cursor is based on the drawing attributes of the current cursor in view. If you then disable the object while keeping the default cursor setting, the cursor override is disabled and the mouse cursor setting is based on the underlying window's mouse cursor attributes. Setting the cursor to null (Nothing in Microsoft® Visual Basic® .NET) also disables the object's cursor handling.

If the cursor is set to anything but the default setting, the object always uses that cursor whether or not the object is enabled.

This property refers to the visual display of the pointer, and not the ink input device, which is represented by the Microsoft.Ink.Cursor class.

Examples

[C#]

This C# example attaches an InkOverlay, theInkOverlay, to the handle for a control. Both theInkOverlay and the control are assigned Cursor Leave Sites such that when theInkOverlay is enabled, the Default Leave Site cursor is used, but when theInkOverlay is not enabled, a cross is used as the cursor.

// In the constructor...
theInkOverlay = new InkOverlay(Handle);
theInkOverlay.Cursor = System.Windows.Forms.Cursors.Default;
Cursor = System.Windows.Forms.Cursors.Cross;

[VB.NET]

This Visual Basic .NET example attaches an InkOverlay, theInkOverlay, to the handle for a control. Both theInkOverlay and the control are assigned Cursor Leave Sites such that when theInkOverlay is enabled, the Default Leave Site cursor is used, but when theInkOverlay is not enabled, a cross is used as the cursor.

'In New() ...
theInkOverlay = New InkOverlay(Handle)
theInkOverlay.Cursor = System.Windows.Forms.Cursors.Default
Cursor = System.Windows.Forms.Cursors.Cross

See Also