RealTimeStylus.Dispose Method

Article
10/20/2012

Releases all resources used by the RealTimeStylus object.

Namespace: Microsoft.StylusInput
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)

Syntax

'Declaration
Public Sub Dispose
'Usage
Dim instance As RealTimeStylus

instance.Dispose()

public void Dispose()

public:
virtual void Dispose() sealed

public final function Dispose()

Implements

IDisposable.Dispose()

Remarks

Calling the Dispose method allows the resources used by the object to be reallocated for other purposes.

The RealTimeStylus object does not guarantee thread safety for the Dispose method. Avoid calling the Dispose method while other threads may be using the RealTimeStylus object.

Warning

Starting with the Microsoft Windows XP Tablet PC Edition Software Development Kit (SDK), you must explicitly call the dispose method on any object or control in to which an event handler has been attached before the object or control goes out of scope.

For any class in the Tablet PC SDK on which Dispose is defined, manually dispose of each instance of that class when it is no longer needed. Disposing of these objects improves your application's performance.

Note

The RealTimeStylus object throws an exception if its Dispose method is called by any of its plug-ins from an IStylusSyncPlugin or IStylusAsyncPlugin interface method implementation.

Examples

This Microsoft Visual C# .NET example is a snippet from a form's Closed event handler, which disables the RealTimeStylus, GestureRecognizer, and DynamicRenderer objects, empties the RealTimeStylus objects' queues, and calls the Dispose method of the objects.

using Microsoft.Ink;
using Microsoft.StylusInput;
using Microsoft.StylusInput.PluginData;

// ...

// Declare the RealTimeStylus objects, the GestureRecognizer plugin,
// and the DynamicRenderer plug-in.
private Microsoft.StylusInput.RealTimeStylus thePrimaryRealTimeStylus = null;
private Microsoft.StylusInput.RealTimeStylus theSecondaryRealTimeStylus = null;
private Microsoft.StylusInput.GestureRecognizer theGestureRecognizer = null;
private Microsoft.StylusInput.DynamicRenderer theDynamicRenderer = null;

// ...

// The form's Closed event handler.
private void theForm_Closed(object sender, System.EventArgs e)
{
    // Disable appropriate plug-ins.
    this.theGestureRecognizer.Enabled = false;
    this.theDynamicRenderer.Enabled = false;
    this.theFilterPlugin.Enabled = false;

    // Empty the RealTimeStylus queues
    this.thePrimaryRealTimeStylus.ClearStylusQueues();
    this.theSecondaryRealTimeStylus.ClearStylusQueues();

    // Disable the RealTimeStylus.
    this.thePrimaryRealTimeStylus.Enabled = false;

    // Dispose of the the RealTimeStylus objects and appropriate plug-ins.
    this.thePrimaryRealTimeStylus.Dispose();
    this.thePrimaryRealTimeStylus = null;
    this.theSecondaryRealTimeStylus.Dispose();
    this.theSecondaryRealTimeStylus = null;
    this.theDynamicRenderer.Dispose();
    this.theDynamicRenderer = null;
    this.theGestureRecognizer.Dispose();
    this.theGestureRecognizer = null;
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

Share via