Share via

InkOverlay.SetAllTabletsMode Method

  • Article

InkOverlay.SetAllTabletsMode Method

Sets the InkOverlay object to collect ink from any tablet attached to the Tablet PC.

Definition

Visual Basic .NET Public Sub SetAllTabletsMode( _
ByVal useMouseForInput As Boolean _
)
C# public void SetAllTabletsMode(
bool useMouseForInput
);
Managed C++ public: void SetAllTabletsMode(
bool *useMouseForInput
);

Parameters

> > >
useMouseForInput System.Boolean. The Boolean value that indicates whether to use the mouse as an input device.

true In addition to the pen, the mouse is used for input.
false The mouse cannot be used for input.

Exceptions

COMException Leave Site:
ObjectDisposedException Leave Site: The InkOverlay object is disposed.

Remarks

This is the default mode for an InkOverlay object. To allow the InkOverlay object to collect ink from only one tablet, call the SetSingleTabletIntegratedMode method.

Note: The InkOverlay object must be disabled before calling this method. To disable the InkOverlay object, set the Enabled property to false. After calling the SetAllTabletsMode method, enable the InkOverlay object by setting the Enabled property to true.

When an InkOverlay object switches from collecting ink by using a single tablet to collecting ink by using all tablets, the Cursors property is set to the empty collection.

Note: If the SetAllTabletsMode method is called with the useMouseForInput parameter set to true (or no parameters), then the mouse is used as an input device. If the SetAllTabletsMode method is then called with the useMouseForInput parameter set to false, the mouse is not removed from the Cursors property.

Examples

[C#]

This C# example calls SetAllTabletsMode on a new InkOverlay object, theInkCollector, with the useMouseForInput parameter set to false if more than one tablet is available.

using Microsoft.Ink;
// . . .
Tablets theTablets = new Tablets();
InkOverlay theInkOverlay = new InkOverlay();
if (theTablets.Count > 1)
    theInkOverlay.SetAllTabletsMode(false);
else
    theInkOverlay.SetAllTabletsMode();

[VB.NET]

This Microsoft® Visual Basic® .NET example calls SetAllTabletsMode on a new InkOverlay object, theInkCollector, with the useMouseForInput parameter set to false if more than one tablet is available.

Imports Microsoft.Ink
' . . .
Dim theTablets As New Tablets()
Dim theInkOverlay As New InkOverlay()
If theTablets.Count > 1 Then
    theInkOverlay.SetAllTabletsMode(False)
Else
    theInkOverlay.SetAllTabletsMode()
End If

See Also