InkOverlay Class

Article
12/12/2007

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.

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in microsoft.ink.dll)

Syntax

'Declaration
Public Class InkOverlay
    Implements IDisposable
'Usage
Dim instance As InkOverlay

public class InkOverlay : IDisposable

public ref class InkOverlay : IDisposable

public class InkOverlay implements IDisposable

public class InkOverlay implements IDisposable

Not applicable.

Remarks

Warning

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.

Warning

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 Note:
If using under partial trust, this class and all its methods require UIPermissionWindow.SafeTopLevelWindowsUIPermissionWindow.SafeTopLevelWindows permission. See Security And Trust for more information.

Inheritance Hierarchy

System.Object
Microsoft.Ink.InkOverlay

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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