SetAllTabletsMode Method

  • Article

SetAllTabletsMode Method

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

Declaration

[C++]

HRESULT SetAllTabletsMode (
    [in, optional, defaultvalue(-1)] VARIANT_BOOL useMouse
);

[Microsoft® Visual Basic® 6.0]

Public Sub SetAllTabletsMode( _
    [useMouse As Boolean = True] _
)

Parameters

useMouse

[in, optional] The Boolean value that indicates whether to use the mouse as an input device. If TRUE, the mouse is used for input.

Return Value

HRESULT value 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 FALSE, the mouse is not removed from the Cursors property.

Example

[Visual Basic 6.0]

This Visual Basic 6.0 example calls SetAllTabletsMode on a new InkCollector object, with the parameter for using the mouse as an input device set to False if more than one tablet is available.

Option Explicit
Dim theInkCollector As InkCollector

Private Sub Form_Load()
    Set theInkCollector = New InkCollector
    theInkCollector.hWnd = Me.hWnd
    Dim theTablets As New InkTablets
    If theTablets.Count > 1 Then
        theInkCollector.SetAllTabletsMode False
    Else
        theInkCollector.SetAllTabletsMode
    End If
    theInkCollector.Enabled = True
End Sub

Applies To