InkOverlay Class

InkOverlay Class

Represents an object that is useful for annotation scenarios where users are not concerned with performing recognition on ink but instead are interested in the size, shape, color, and position of the ink.

Definition

Visual Basic .NET	Public Class InkOverlay Inherits Object Implements IDisposable
C#	public class InkOverlay : Object, IDisposable
Managed C++	public __gc class InkOverlay : public Object, IDisposable

Members Table

The following table lists the members exposed by the object.

Events

Event	Description
CursorButtonDown	Occurs when the InkOverlay detects a cursor button that is down.
CursorButtonUp	Occurs when the InkOverlay detects a cursor button that is up.
CursorDown	Occurs when the cursor tip contacts the digitizing tablet surface.
CursorInRange	Occurs when a cursor enters the physical detection range (proximity) of the tablet context.
CursorOutOfRange	Occurs when a cursor leaves the physical detection range (proximity) of the tablet context.
DoubleClick	Occurs when the InkOverlay object is double-clicked.
Gesture	Occurs when an application-specific gesture is recognized.
MouseDown	Occurs when the mouse pointer is over the InkOverlay and a mouse button is pressed.
MouseMove	Occurs when the mouse pointer is moved over the InkOverlay.
MouseUp	Occurs when the mouse pointer is over the InkOverlay and a mouse button is released.
MouseWheel	Occurs when the mouse wheel moves while the InkOverlay object has focus.
NewInAirPackets	Occurs when an in-air packet is seen, which happens when a user moves a pen near the tablet and the cursor is within the InkOverlay object's window or the user moves a mouse within the InkOverlay object's associated window.
NewPackets	Occurs when the InkOverlay receives packets.
Painted	Occurs when the InkOverlay object has completed redrawing itself.
Painting	Occurs before the InkOverlay object redraws itself.
SelectionChanged	Occurs when the selection of ink within the control has changed, such as through alterations to the user interface, cut-and-paste procedures, or the Selection property.
SelectionChanging	Occurs when the selection of ink within the control is about to change, such as through alterations to the user interface, cut-and-paste procedures, or the Selection property.
SelectionMoved	Occurs when the position of the current selection has changed, such as through alterations to the user interface, cut-and-paste procedures, or the Selection property.
SelectionMoving	Occurs when the position of the current selection is about to change, such as through alterations to the user interface, cut-and-paste procedures, or the Selection property.
SelectionResized	Occurs when the size of the current selection has changed, such as through alterations to the user interface, cut-and-paste procedures, or the Selection property.
SelectionResizing	Occurs when the size of the current selection is about to change, such as through alterations to the user interface, cut-and-paste procedures, or the Selection property.
Stroke	Occurs when the user finishes drawing a new stroke on any tablet.
StrokesDeleted	Occurs after strokes have been deleted from the Ink property.
StrokesDeleting	Occurs before strokes are deleted from the Ink property.
SystemGesture	Occurs when a system gesture is recognized.
TabletAdded	Occurs when a Tablet is added to the system.
TabletRemoved	Occurs when a Tablet is removed from the system.

Fields

Field	Description
ClipInkToMargin	Not implemented.
DefaultMargin	Returns the default margin used by the MarginX and MarginY properties.

Methods

Method	Description
Dispose	Releases resources used by the InkOverlay object.
Draw	Sets a rectangle in which to redraw the ink within the InkOverlay object.
Equals	Determines whether two Object instances are equal. Inherited from Object .
Finalize	Frees the resources of the current InkOverlay object before it is reclaimed by the garbage collector.
GetGestureStatus	Returns a value that indicates whether the InkOverlay object has interest in a particular application gesture.
GetHashCode	Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. Inherited from Object .
GetType	Gets the Type of the current instance. Inherited from Object .
GetWindowInputRectangle	Gets the window rectangle, in pixels, within which ink is drawn.
HitTestSelection	Returns a value that indicates which part of a selection, if any, was hit during a hit test.
InkOverlay	Initializes a new instance of the InkOverlay class.
MemberwiseClone	Creates a shallow copy of the current Object . Inherited from Object .
OnCursorButtonDown	Allows derived classes to modify the default behavior of the CursorButtonDown event.
OnCursorButtonUp	Allows derived classes to modify the default behavior of the CursorButtonUp event.
OnCursorDown	Allows derived classes to modify the default behavior of the CursorDown event.
OnCursorInRange	Allows derived classes to modify the default behavior of the CursorInRange event.
OnCursorOutOfRange	Allows derived classes to modify the default behavior of the CursorOutOfRange event.
OnDoubleClick	Allows derived classes to modify the default behavior of the DoubleClick event.
OnGesture	Allows derived classes to modify the default behavior of the Gesture event.
OnMouseDown	Allows derived classes to modify the default behavior of the MouseDown event.
OnMouseMove	Allows derived classes to modify the default behavior of the MouseMove event.
OnMouseUp	Allows derived classes to modify the default behavior of the MouseUp event.
OnMouseWheel	Allows derived classes to modify the default behavior of the MouseWheel event.
OnNewInAirPackets	Allows derived classes to modify the default behavior of the NewInAirPackets event.
OnNewPackets	Allows derived classes to modify the default behavior of the NewPackets event.
OnPainted	Allows derived classes to modify the default behavior of the Painted event.
OnPainting	Allows derived classes to modify the default behavior of the Painting event.
OnSelectionChanged	Allows derived classes to modify the default behavior of the SelectionChanged event.
OnSelectionChanging	Allows derived classes to modify the default behavior of the SelectionChanging event.
OnSelectionMoved	Allows derived classes to modify the default behavior of the SelectionMoved event.
OnSelectionMoving	Allows derived classes to modify the default behavior of the SelectionMoving event.
OnSelectionResized	Allows derived classes to modify the default behavior of the SelectionResized event.
OnSelectionResizing	Allows derived classes to modify the default behavior of the SelectionResizing event.
OnStroke	Allows derived classes to modify the default behavior of the Stroke event.
OnStrokesDeleted	Allows derived classes to modify the default behavior of the StrokesDeleted event.
OnStrokesDeleting	Allows derived classes to modify the default behavior of the StrokesDeleting event.
OnSystemGesture	Allows derived classes to modify the default behavior of the SystemGesture event.
OnTabletAdded	Allows derived classes to modify the default behavior of the TabletAdded event.
OnTabletRemoved	Allows derived classes to modify the default behavior of the TabletRemoved event.
ReferenceEquals	Determines whether the specified Object instances are the same instance. Inherited from Object .
SetAllTabletsMode	Sets the InkOverlay object to collect ink from any tablet attached to the Tablet PC.
SetGestureStatus	Sets whether or not the InkOverlay object has interest in a known application gesture.
SetSingleTabletIntegratedMode	Sets the InkOverlay object to collect ink from only one tablet attached to the Tablet PC. Ink from other tablets is ignored by the InkOverlay object.
SetWindowInputRectangle	Sets the window rectangle, in pixels, within which ink is drawn.
ToString	Returns a String that represents the current Object . Inherited from Object .

Properties

Property	Description
AttachedControl	Gets or sets the control to which the InkOverlay object is attached.
AttachMode	Gets or sets the value that specifies whether the InkOverlay object is attached behind or in front of the known window.
AutoRedraw	Gets or sets a value that specifies whether the InkOverlay object repaints the ink when the window is invalidated.
CollectingInk	Gets a value that specifies whether ink is currently being drawn on an InkOverlay object.
CollectionMode	Gets or sets the collection mode that determines whether ink, gestures, or both are recognized as the user writes.
Cursor	Gets or sets the cursor that appears when the mouse pointer is over the InkPicture control.
Cursors	Gets the Cursors collection that is available for use in the inking region.
DefaultDrawingAttributes	Gets or sets the default DrawingAttributes object, which specifies the drawing attributes that are used when drawing and displaying ink.
DesiredPacketDescription	Gets or sets interest in aspects of the packets associated with ink drawn on the InkOverlay object.
DynamicRendering	Gets or sets a value that indicates whether ink is rendered as it is drawn.
EditingMode	Gets or sets a value that indicates whether the InkOverlay is in ink mode, deletion mode, or selecting/editing mode.
Enabled	Gets or sets a value that specifies whether the InkOverlay object collects pen input.
EraserMode	Gets or sets a value that indicates whether ink is erased by stroke or by point.
EraserWidth	Gets or sets a value that specifies the width of the eraser pen tip.
Handle	Gets or sets the handle of the window to which the InkOverlay object is attached.
Ink	Gets or sets the Ink object that is associated with the InkOverlay object.
MarginX	Gets or sets the margins along the x-axis, in pixels.
MarginY	Gets or sets the margins along the y-axis, in pixels.
Renderer	Gets or sets the Renderer object that is used to draw ink.
Selection	Gets or sets the Strokes collection that is currently selected inside the InkOverlay control.
SupportHighContrastInk	Gets or sets a value that specifies whether ink is rendered as just one color when the system is in High Contrast mode.
SupportHighContrastSelectionUI	Gets or sets a value that specifies whether all selection UI are drawn in high contrast when the system is in High Contrast mode.
Tablet	Gets the tablet device that the InkOverlay object is currently using to collect input.

Inheritance Hierarchy

Object

InkOverlay

Remarks

Caution: To avoid a memory leak you must explicitly call the Dispose method on any InkOverlay object to which an event handler has been attached before the object goes out of scope.

The InkOverlay object is well suited for note taking and basic scribbling. The primary intended use of this object is to display ink as ink.

In general, the run-time user interface for this object is a transparent window with opaque ink.

The MouseDown, MouseMove, MouseUp, and MouseWheel events return x- and y-coordinates in pixels, and not the HIMETRIC units that are associated with the ink space. This is because these events replace the mouse events of pen-unaware applications and these applications understand only pixels.

Caution: If you are setting the InkOverlay object's AttachMode property to InFront, then create the InkOverlay object in the thread in which the form is running. Your application may stop responding if the InkOverlay object is created in a different thread and its AttachMode property is set to InFront.

Note: The InkOverlay object cannot be safely released on a non-user interface (UI) thread.

To improve your application's performance, manually dispose of an InkOverlay object when it is no longer needed.

Security Alert: If using under partial trust, this class and all its methods require UIPermissionWindow.SafeTopLevelWindows permission. See Security And Trust for more information.

Class Information

Namespace	Microsoft.Ink
Assembly	Microsoft.Ink (microsoft.ink.dll)
Strong Name	Microsoft.Ink, Version=1.7.4009.0, Culture=neutral, PublicKeyToken=a2870d9cc4d021c8

See Also

• InkCollector Class
• InkPicture Class
• InkEdit Class