IInkRecognizerContext::put_Factoid method (msinkaut.h)

Article
02/22/2024

Gets or sets the factoid that a recognizer uses to constrain its search for the recognition result.

This property is read/write.

Syntax

HRESULT put_Factoid(
  BSTR factoid
);

Parameters

factoid

Return value

None

Remarks

A factoid provides recognizer context for recognized ink in the context of a particular field. You specify a factoid if an input field is of a known type, for example, if the input field contains a date.

For more information about factoids and how to use them, see Improving Tablet PC Recognition Accuracy by Setting Context.

Setting the Factoid succeeds only if the InkStrokes collection is NULL. You must set the Factoid before you attach the InkStrokes collection to the InkRecognizerContext or you must set the Strokes collection to NULL and then set the Factoid (and possibly reattach the InkStrokes collection).

To ensure that ink is recognized in the correct field context, set this property before processing the ink for the first time, such as before calling the Recognize method.

Note All factoids are case sensitive.

This property takes or returns a string parameter and not a class object of the Factoid class. The members of this class are of type string.

For the InkEdit control, this property should only be changed if the Status property returns IES_Idle.

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