InkPicture.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 Overrides Property Cursor As Cursor
'Usage
Dim instance As InkPicture
Dim value As Cursor

value = instance.Cursor

instance.Cursor = value

public override Cursor Cursor { get; set; }

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

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

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

public override function get Cursor () : Cursor

public override 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 creates an InkPicture control, for which the InkEnabled property is linked to a button's click event, InkEnableToggle_Click. The InkEnableToggle_Click event assigns a Cursor such that when InkPicture.InkEnabled is true, the Default cursor is used, but when InkPicture.InkEnabled is false, a cross is used as the cursor.

[C#]

using Microsoft.Ink;
//. . .

private void InkEnableToggle_Click(object sender, System.EventArgs e)
{
    if (theInkPicture.InkEnabled == false)
    {
        theInkPicture.InkEnabled = true;
        theInkPicture.Cursor = System.Windows.Forms.Cursors.Default;
    }
    else
    {
        theInkPicture.InkEnabled = false;
        theInkPicture.Cursor = System.Windows.Forms.Cursors.Cross;
    }
}

This Visual Basic .NET example creates an InkPicture control, for which the InkEnabled property is linked to a button's click event, InkEnableToggle_Click. The InkEnableToggle_Click event assigns a Cursor such that when InkPicture.InkEnabled is true, the Default cursor is used, but when InkPicture.InkEnabled is false, a cross is used as the cursor.

Imports Microsoft.Ink
'. . .

Private Sub InkEnableToggle_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles InkEnableToggle.Click
    If theInkPicture.InkEnabled = False Then
        theInkPicture.InkEnabled = True
        theInkPicture.Cursor = System.Windows.Forms.Cursors.Default
    Else
        theInkPicture.InkEnabled = False
        theInkPicture.Cursor = System.Windows.Forms.Cursors.Cross
    End If

End Sub

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