Share via


InkOverlay.Cursor Property

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
<BrowsableAttribute(True)> _
Public Property Cursor As Cursor
'Usage
Dim instance As InkOverlay 
Dim value As Cursor 

value = instance.Cursor

instance.Cursor = value
[BrowsableAttribute(true)]
public Cursor Cursor { get; set; }
[BrowsableAttribute(true)]
public:
property Cursor^ Cursor {
    Cursor^ get ();
    void set (Cursor^ value);
}
public function get Cursor () : Cursor 
public function set Cursor (value : Cursor)

Property Value

Type: System.Windows.Forms.Cursor
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 nulla 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.

Examples

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 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.0

See Also

Reference

InkOverlay Class

InkOverlay Members

Microsoft.Ink Namespace

InkOverlay.Enabled

System.Windows.Forms.Cursor

System.Windows.Forms.Cursors