PenInputPanel.Factoid property

Applies to: desktop apps only

Deprecated. The PenInputPanel has been replaced by the Text Input Panel (TIP).

Gets or sets the string name of the factoid used by the PenInputPanel object.

This property is read/write.

Syntax

HRESULT put_Factoid(
  [in]           BSTR Factoid
);

HRESULT get_Factoid(
  [out, retval]  BSTR *Factoid
);

Property value

The name of the factoid used by the PenInputPanel object.

For more information about the BSTR data type, see Using the COM Library.

Error codes

NameMeaning
S_OK

Success.

TPC_E_OUT_OF_ORDER_CALL

This property cannot be assigned after strokes have been added to the control.

E_NOTIMPL

The recognizer does not support this method.

E_OUTOFMEMORY

Cannot allocate memory to complete the operation.

E_FAIL

An unspecified error occurred.

E_INK_EXCEPTION

An exception occurred.

E_INVALIDARG

The context is invalid or the parameter is an invalid pointer.

E_UNEXPECTED

Unexpected parameter or property type.

Remarks

A factoid provides a recognizer context for ink within 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, specify the Date factoid.

For more information about factoids and how to use them, see Using Context to Improve Accuracy. For a list of possible values for the Factoid property, see Supported Factoids from Version 1.

Note  String representations of factoids are case-sensitive.

This property has no effect on keypads or keyboards.

The WordList factoid is not supported for the PenInputPanel object.

The default value for the Factoid property is DEFAULT. In locales that use recognizers of Latin script, all factoids may be used. In locales that use recognizers of East Asian characters, the following factoid values are relevant:

  • DIGIT: Implies the Num bias button on the East Asian writing pad.
  • ONECAHR: Implies the Alpha bias button on the East Asian writing pad.
  • Common factoids (JapaneseCommon, ChineseSimpleCommon, ChineseTraditionalCommon, KoreanCommon, KanjiCommon, and HangulCommon) imply the Alpha/Num bias button on the East Asian writing pad.

All factoid values other than DIGIT and ONECHAR are interpreted as the common factoid that is appropriate for the current input locale.

If the Factoid property is set, it is forwarded to the recognizer only if the SetInputScope function has not also been called.

Requirements

Minimum supported client

Windows XP Tablet PC Edition

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

PenInputPanel
Factoid Constants

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Community Additions

ADD
Show:
© 2015 Microsoft