InkCollector.SetAllTabletsMode Method

  • Article

InkCollector.SetAllTabletsMode Method

Sets the InkCollector 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 InkCollector object is disposed.

Remarks

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

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

When an InkCollector 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 InkCollector object, theInkCollector, with the useMouseForInput parameter set to false if more than one tablet is available.

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

[VB.NET]

This Microsoft® Visual Basic® .NET example calls SetAllTabletsMode on a new InkCollector 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 theInkCollector As New InkCollector()
If theTablets.Count > 1 Then
    theInkCollector.SetAllTabletsMode(False)
Else
    theInkCollector.SetAllTabletsMode()
End If

See Also