Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

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.

Members

EnumerationDescription
InkApplicationGestureDefines values for the set of available application-specific gestures.
InkCollectionModeDefines values that determine whether ink, gestures, or ink and gestures are recognized as the user writes.
InkCollectorEventInterestDefines values that set the interest in ink collector events.
InkMouseButtonDefines values that specify which mouse button was pressed.
InkMousePointerDefines values that specify the type of mouse pointer to appear.
InkOverlayAttachModeDefines values that specify where to attach the new InkOverlay object, behind or in front of the active layer.
InkOverlayEditingModeDefines values that specify the behavior mode of the InkOverlay object
InkOverlayEraserModeDefines values that specify the way in which ink is erased from the InkOverlay object. This mode is used when the EditingMode property is set to Delete.
SelectionHitResultDefines values that specify which part of a selection, if any, was hit during a hit test.
InkShiftKeyModifierFlagsDefines values that specify which modifier key was pressed.
InkSystemGestureDefines values that set the interest in a set of system-specific gestures.

EventDescription
CursorButtonDownOccurs when the InkOverlay detects a cursor button that is down.
CursorButtonUpOccurs when the InkOverlay detects a cursor button that is up.
CursorDownOccurs when the cursor tip contacts the digitizing tablet surface.
CursorInRangeOccurs when a cursor enters the physical detection range (proximity) of the tablet context.
CursorOutOfRangeOccurs when the cursor leaves the physical detection range (proximity) of the tablet context.
DoubleClickOccurs when the InkOverlay object is double-clicked.
GestureOccurs when an application-specific gesture is recognized.
MouseDownOccurs when the mouse pointer is over the InkOverlay object and a mouse button is pressed.
MouseMoveOccurs when the mouse pointer is moved over the InkOverlay object.
MouseUpOccurs when the mouse pointer is over the InkOverlay object and a mouse button is released.
MouseWheelOccurs when the mouse wheel moves while the InkOverlay object has focus.
NewInAirPacketsOccurs 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 object's associated window.
NewPacketsOccurs when the InkOverlay object receives packets.
PaintedOccurs when the InkOverlay object has completed redrawing itself.
PaintingOccurs before the InkOverlay object redraws itself.
SelectionChangedOccurs 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.
SelectionChangingOccurs 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.
SelectionMovedOccurs 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.
SelectionMovingOccurs 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.
SelectionResizedOccurs 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.
SelectionResizingOccurs 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.
StrokeOccurs when the user finishes drawing a new stroke on any tablet.
StrokesDeletedOccurs after strokes have been deleted from the Ink property.
StrokesDeletingOccurs before strokes are deleted from the Ink property.
SystemGestureOccurs when a system gesture is recognized.
TabletAddedOccurs when a IInkTablet is added to the system.
TabletRemovedOccurs when a Tablet is removed from the system.

MethodDescription
DrawSets a rectangle in which to redraw the ink within the InkOverlay object.
GetEventInterestReturns the current state of a particular InkOverlay object event, that is, whether the event is being listened for or used.
GetGestureStatusReturns whether the InkOverlay object is interested in a particular gesture.
GetWindowInputRectangleRetrieves the window rectangle, in pixels, within which ink is drawn.
HitTestSelectionDetermines what portion of the selection was hit during a hit test.
SetAllTabletsModeThis mode allows the InkOverlay object object to collect ink from any tablet attached to the Tablet PC.
SetEventInterestSets whether a specific event should be listened for or used.
SetGestureStatusSets the interest of the InkOverlay object in a known gesture.
SetSingleTabletIntegratedModeThis mode allows the InkOverlay object object to collect ink from only one tablet. Ink from other tablets is ignored by the InkOverlay object.
SetWindowInputRectangleSets the window rectangle, in pixels, to use to map drawn ink to the window.

PropertyDescription
AttachModeGets or sets the value that specifies whether the InkOverlay object is attached behind or in front of the known window.
AutoRedrawGets or sets a value that specifies whether the InkOverlay repaints the ink when the window is invalidated.
CollectingInkGets a value that specifies whether ink is currently being drawn on an InkOverlay object.
CollectionModeGets or sets the collection mode that determines whether ink, gestures, or both are recognized as the user writes.
CursorsGets the Cursors collection that is available for use in the inking region.
DefaultDrawingAttributesGets or sets the default InkDrawingAttributes object, which specifies the drawing attributes that are used when drawing and displaying ink.
DesiredPacketDescriptionGets or sets interest in aspects of the packets associated with ink drawn on the InkOverlay object.
DynamicRenderingGets or sets a value that indicates whether ink is rendered as it is drawn.
EditingModeGets or sets a value that indicates whether the InkOverlay is in ink mode, deletion mode, or selecting/editing mode.
EnabledGets or sets a value that specifies whether the InkOverlay object collects pen input.
EraserModeGets or sets a value that indicates whether ink is erased by stroke or by point.
EraserWidthGets or sets a value that specifies the width of the eraser pen tip.
HandleGets or sets the handle of the window to which the InkOverlay object is attached.
InkGets or sets the InkDisp object that is associated with the InkOverlay object.
MarginXGets or sets the margins along the x-axis, in pixels.
MarginYGets or sets the margins along the y-axis, in pixels.
MouseIconGets or sets the current custom mouse icon.
MousePointerGets or sets a value that indicates the type of mouse pointer that appears when the mouse is over a particular part of the object.
RendererGets or sets the InkRenderer object that is used to draw ink.
SelectionGets or sets the InkStrokes collection that is currently selected inside the InkOverlay control.
SupportHighContrastInkGets or sets a value that specifies whether ink is rendered as just one color when the system is in High Contrast mode.
SupportHighContrastSelectionUIGets or sets a value that specifies whether all selection UI are drawn in high contrast when the system is in High Contrast mode.
TabletGets the tablet device that the InkOverlay object is currently using to collect input.

Remarks

This object can be instantiated by calling the CoCreateInstance method in C++ or by using the New keyword in Microsoft® Visual Basic® 6.0.

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-UI thread.

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

COM Implementation

This object implements the IInkOverlay COM interface.

Related Topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.