InkOverlay.Cursor Property

Article
12/12/2007

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

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in microsoft.ink.dll)

Syntax

'Declaration
Public Property Cursor As Cursor
'Usage
Dim instance As InkOverlay
Dim value As Cursor

value = instance.Cursor

instance.Cursor = value

public Cursor Cursor { get; set; }

public:
property Cursor^ Cursor {
    Cursor^ get ();
    void set (Cursor^ value);
}

/** @property */
public Cursor get_Cursor ()

/** @property */
public void set_Cursor (Cursor value)

public function get Cursor () : Cursor

public function set Cursor (value : Cursor)

Not applicable.

Property Value

The cursor that appears when the mouse pointer is over the InkPicture control.

Remarks

If set to the default cursor, the inherited Default 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 a null reference (Nothing in Visual Basic) (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.

Example

This C# example attaches an InkOverlay, theInkOverlay, to the handle for a control. Both theInkOverlay and the control are assigned Cursors such that when theInkOverlay is enabled, the Default 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;

This Visual Basic .NET example attaches an InkOverlay, theInkOverlay, to the handle for a control. Both theInkOverlay and the control are assigned Cursors such that when theInkOverlay is enabled, the Default 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

Platforms

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0

Share via