Share via


InkOverlay Members

Include Protected Members
Include Inherited Members

Include .NET Framework Members
Include .NET Compact Framework Members
Include XNA Framework Members

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.

The InkOverlay type exposes the following members.

Constructors

  Name Description
Public method InkOverlay Overloaded. Initializes a new instance of the InkOverlay class.

Top

Methods

  Name Description
Public method Dispose Overloaded. Releases resources used by the InkOverlay object.
Public method Draw Sets a rectangle in which to redraw the ink within the InkOverlay object.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Frees the resources of the current InkOverlay object before it is reclaimed by the garbage collector. (Overrides Object.Finalize().)
Public method GetGestureStatus Returns a value that indicates whether the InkOverlay object has interest in a particular application gesture.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the type of the current instance. (Inherited from Object.)
Public method GetWindowInputRectangle Gets the window rectangle, in pixels, within which ink is drawn.
Public method HitTestSelection Returns a value that indicates which part of a selection, if any, was hit during a hit test.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnCursorButtonDown Allows derived classes to modify the default behavior of the CursorButtonDown event.
Protected method OnCursorButtonUp Allows derived classes to modify the default behavior of the CursorButtonUp event.
Protected method OnCursorDown Allows derived classes to modify the default behavior of the CursorDown event.
Protected method OnCursorInRange Allows derived classes to modify the default behavior of the CursorInRange event.
Protected method OnCursorOutOfRange Allows derived classes to modify the default behavior of the CursorOutOfRange event.
Protected method OnDoubleClick Allows derived classes to modify the default behavior of the DoubleClick event.
Protected method OnGesture Allows derived classes to modify the default behavior of the Gesture event.
Protected method OnMouseDown Allows derived classes to modify the default behavior of the MouseDown event.
Protected method OnMouseMove Allows derived classes to modify the default behavior of the MouseMove event.
Protected method OnMouseUp Allows derived classes to modify the default behavior of the MouseUp event.
Protected method OnMouseWheel Allows derived classes to modify the default behavior of the MouseWheel event.
Protected method OnNewInAirPackets Allows derived classes to modify the default behavior of the NewInAirPackets event.
Protected method OnNewPackets Allows derived classes to modify the default behavior of the NewPackets event.
Protected method OnPainted Allows derived classes to modify the default behavior of the Painted event.
Protected method OnPainting Allows derived classes to modify the default behavior of the Painting event.
Protected method OnSelectionChanged Allows derived classes to modify the default behavior of the SelectionChanged event.
Protected method OnSelectionChanging Allows derived classes to modify the default behavior of the SelectionChanging event.
Protected method OnSelectionMoved Allows derived classes to modify the default behavior of the SelectionMoved event.
Protected method OnSelectionMoving Allows derived classes to modify the default behavior of the SelectionMoving event.
Protected method OnSelectionResized Allows derived classes to modify the default behavior of the SelectionResized event.
Protected method OnSelectionResizing Allows derived classes to modify the default behavior of the SelectionResizing event.
Protected method OnStroke Allows derived classes to modify the default behavior of the Stroke event.
Protected method OnStrokesDeleted Allows derived classes to modify the default behavior of the StrokesDeleted event.
Protected method OnStrokesDeleting Allows derived classes to modify the default behavior of the StrokesDeleting event.
Protected method OnSystemGesture Allows derived classes to modify the default behavior of the SystemGesture event.
Protected method OnTabletAdded Allows derived classes to modify the default behavior of the TabletAdded event.
Protected method OnTabletRemoved Allows derived classes to modify the default behavior of the TabletRemoved event.
Public method SetAllTabletsMode Overloaded. Sets the InkOverlay object to collect ink from any tablet attached to the Tablet PC.
Public method SetGestureStatus Sets whether or not the InkOverlay object has interest in a known application gesture.
Public method 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.
Public method SetWindowInputRectangle Sets the window rectangle, in pixels, within which ink is drawn.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

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

Top

Properties

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

Top

Events

  Name Description
Public event CursorButtonDown Occurs when the InkOverlay object detects a CursorButton object that is down.
Public event CursorButtonUp Occurs when the InkOverlay object detects a CursorButton object that is up.
Public event CursorDown Occurs when the cursor tip contacts the digitizing tablet surface.
Public event CursorInRange Occurs when a cursor enters the physical detection range (proximity) of the tablet context.
Public event CursorOutOfRange Occurs when a cursor leaves the physical detection range (proximity) of the tablet context.
Public event DoubleClick Occurs when a user double-clicks a InkOverlay object.
Public event Gesture Occurs when an application gesture is recognized.
Public event MouseDown Occurs when the mouse pointer is over the InkOverlay object and the user presses a mouse button.
Public event MouseMove Occurs when the user moves the mouse pointer over the InkOverlay object.
Public event MouseUp Occurs when a user releases a mouse button while the mouse pointer is over the InkOverlay object.
Public event MouseWheel Occurs when a user moves the mouse wheel while the InkOverlay object has focus.
Public event NewInAirPackets Occurs when the InkOverlay object detects an in-air packet.
Public event NewPackets Occurs when the InkOverlay receives packets.
Public event Painted Occurs when the InkOverlay object has completed redrawing itself.
Public event Painting Occurs before the InkOverlay object redraws itself.
Public event SelectionChanged Occurs when the selection of ink within the InkOverlay object has changed, such as through alterations to the user interface, cut-and-paste procedures, or the Selection property.
Public event 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.
Public event 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.
Public event 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.
Public event 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.
Public event 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.
Public event Stroke Occurs when the user finishes drawing a new stroke on any tablet.
Public event StrokesDeleted Occurs after one or more Stroke objects have been deleted from the InkOverlay.Ink property.
Public event StrokesDeleting Occurs before strokes are deleted from the Ink property.
Public event SystemGesture Occurs when a system gesture is recognized.
Public event TabletAdded Occurs when a Tablet object is added to the system.
Public event TabletRemoved Occurs when a Tablet object is removed from the system.

Top

See Also

Reference

InkOverlay Class

Microsoft.Ink Namespace