InkCollectorCursorButtonDownEventArgs.Cursor Property
Gets the Cursor object that generated the CursorButtonDown event.
Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)
Syntax
'Declaration
Public ReadOnly Property Cursor As Cursor
'Usage
Dim instance As InkCollectorCursorButtonDownEventArgs
Dim value As Cursor
value = instance.Cursor
public Cursor Cursor { get; }
public:
property Cursor^ Cursor {
Cursor^ get ();
}
public function get Cursor () : Cursor
Property Value
Type: Microsoft.Ink.Cursor
The object that generated the CursorButtonDown event.
Remarks
The Microsoft.Ink.Cursor class is not to be confused with System.Windows.Forms.Cursor class. Microsoft.Ink.Cursor represents general information about a tablet pointing and selecting device, usually a pen, while System.Windows.Forms.Cursor represents the image used to paint the mouse pointer.
Examples
The following example shows how you can subscribe to the CursorInRange event, CursorButtonDown event, and the CursorButtonUp event in order to have the ink pointer (when inking with the mouse) be displayed using a different color than the ink itself.
When the CursorInRange event fires, a check is made to see if this is the first time that the InkCollector object has come in contact with this particular Cursor object. If so, the DrawingAttributes property is assigned with a clone of the DefaultDrawingAttributes property. This ensures that subsequent access to the DrawingAttributes property does not throw a null reference exception. If the mouse is being used, the ink color is set to red.
Private Sub mInkObject_CursorInRange(ByVal sender As Object, ByVal e As InkCollectorCursorInRangeEventArgs)
Const MOUSE_CURSOR_ID As Integer = 1
If e.NewCursor Then
' mInkObject can be InkCollector, InkOverlay, or InkPicture
e.Cursor.DrawingAttributes = mInkObject.DefaultDrawingAttributes.Clone()
' if this cursor is the mouse, we'll set color to red
If (MOUSE_CURSOR_ID = e.Cursor.Id) Then
e.Cursor.DrawingAttributes.Color = Color.Red
End If
End If
End Sub
private void mInkObject_CursorInRange(object sender, InkCollectorCursorInRangeEventArgs e)
{
const int MOUSE_CURSOR_ID = 1;
if (e.NewCursor)
{
// mInkObject can be InkCollector, InkOverlay, or InkPicture
e.Cursor.DrawingAttributes = mInkObject.DefaultDrawingAttributes.Clone();
// if this cursor is the mouse, we'll set color to red
if (MOUSE_CURSOR_ID == e.Cursor.Id)
{
e.Cursor.DrawingAttributes.Color = Color.Red;
}
}
}
When the CursorButtonDown event fires, a check is made to see if the Cursor object supplied to the event is the mouse. If so, the Color property is to set to blue.
Private Sub mInkObject_CursorButtonDown(ByVal sender As Object, ByVal e As InkCollectorCursorButtonDownEventArgs)
Const MOUSE_CURSOR_ID As Integer = 1
If (MOUSE_CURSOR_ID = e.Cursor.Id) Then
e.Cursor.DrawingAttributes.Color = Color.Blue
End If
End Sub
private void mInkObject_CursorButtonDown(object sender, InkCollectorCursorButtonDownEventArgs e)
{
const int MOUSE_CURSOR_ID = 1;
if (MOUSE_CURSOR_ID == e.Cursor.Id)
{
e.Cursor.DrawingAttributes.Color = Color.Blue;
}
}
When the CursorButtonUp event fires, a check is made to see if the Cursor object supplied to the event is the mouse. If so, the Color property is to set back to red.
Private Sub mInkObject_CursorButtonUp(ByVal sender As Object, ByVal e As InkCollectorCursorButtonUpEventArgs)
Const MOUSE_CURSOR_ID As Integer = 1
If (MOUSE_CURSOR_ID = e.Cursor.Id) Then
e.Cursor.DrawingAttributes.Color = Color.Red
End If
End Sub
private void mInkObject_CursorButtonUp(object sender, InkCollectorCursorButtonUpEventArgs e)
{
const int MOUSE_CURSOR_ID = 1;
if (MOUSE_CURSOR_ID == e.Cursor.Id)
{
e.Cursor.DrawingAttributes.Color = Color.Red;
}
}
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
InkCollectorCursorButtonDownEventArgs Class