IInkCollector::SetAllTabletsMode method (msinkaut.h)

Article
02/22/2024

Allows an ink collector (InkCollector, InkOverlay, or InkPicture) to collect ink from any tablet attached to the Tablet PC.

Syntax

HRESULT SetAllTabletsMode(
  [in, optional] VARIANT_BOOL UseMouseForInput
);

Parameters

[in, optional] UseMouseForInput

VARIANT_TRUE to use the mouse for input; otherwise, VARIANT_FALSE. The default value is VARIANT_TRUE. This parameter is optional.

Return value

This method can return one of these values.

Return code	Description
S_OK	Success.
E_INK_COLLECTOR_ENABLED	Cannot change modes while the InkCollector is enabled.
E_INK_EXCEPTION	An exception occurred inside the method.
E_INVALIDARG	The flag is invalid.

Remarks

This is the default mode for an object or control that collects ink. To allow the ink collector to collect ink from only one tablet, call the SetSingleTabletIntegratedMode method.

Note The ink collector must be disabled before calling this method. To disable the InkCollector object or the InkOverlay object, set the Enabled property to FALSE. To disable the InkPicture control, set the InkEnabled property to FALSE. After calling the SetAllTabletsMode method, re-enable the object or control by setting the Enabled (or InkEnabled) property to TRUE.

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

Note If the SetAllTabletsMode method is called with the useMouse parameter set to TRUE, the mouse is used as an input device. If the SetAllTabletsMode method is then called with the useMouse parameter set to VARIANT_FALSE, the mouse is not removed from the Cursors property.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	msinkaut.h
Library	InkObj.dll