Export (0) Print
Expand All

Predefined Properties

The following values identify TSF-defined properties. The data format and contents of each property type are included.

Properties

PropertyDescription
GUID_PROP_ATTRIBUTE Contains a TfGuidAtom value that represents the GUID of the display attribute. ITfCategoryMgr::GetGUID is used to convert this value into a GUID. For more information, see Using Display Attributes.
GUID_PROP_TEXTOWNER Contains a TfGuidAtom value that represents the class identifier ( CLSID ) of the text service that owns the text. ITfCategoryMgr::GetGUID is used to convert this value into a CLSID.
GUID_PROP_LANGID Contains a DWORD value that contains the language identifier ( LANGID ) of the text in the low word.
GUID_PROP_READING Contains the phonetic reading text for the text covered by the property. This can be different from the actual text. Windows Store apps don't support this property.
GUID_PROP_COMPOSING Contains a Boolean value that is nonzero if the text is part of a composition or zero otherwise. If this property is VT_EMPTY, it can be assumed that the text is not part of a composition.
GUID_PROP_MODEBIAS Contains a TfGuidAtom value that represents the type of mode bias supported. ITfCategoryMgr::GetGUID is used to convert this value into a GUID. This can be one of the mode bias values.
GUID_PROP_LMLATTICE Contains a pointer to an ITfLMLattice object.
GUID_PROP_TKB_ALTERNATES

Starting with Windows 8: Contains a DWORD value set by the touch keyboard. This property can be used by TSF-aware edit controls and apps to identify the nature of the text in the text range covered by the property, for example, if the text in the range results from the insertion of a text suggestion or autocorrection.

The nature of the text in the text range covered by the property also extends to the type of alternates that would be returned by the ITfFnReconversion interface for that text range in the document.

See the following Remarks for the possible values of this property.

 

Remarks

The GUID_PROP_TKB_ALTERNATES property can be one of the following values.

NameValueDescription
TKB_ALTERNATES_STANDARD0x00000001Indicates that the touch keyboard has generated a list of possible alternate words for the text in the range covered by the property, and that neither the text range nor the alternates are an autocorrection or a text suggestion.
TKB_ALTERNATES_FOR_AUTOCORRECTION0x00000002

Indicates that the touch keyboard has generated an alternate word which should automatically replace the text in the text range covered by the property.

The touch keyboard will not apply the autocorrection without being instructed to do so by the edit control or app. The reconversion interface (ITfFnReconversion) should be used to apply the correction to the text in the document.

TKB_ALTERNATES_FOR_PREDICTION0x00000003

Indicates that the text range covered by the property is a text suggestion that has been generated by the touch keyboard and inserted into the document by the user.

Additional alternate predictions can also be stored as a property in the document.

TKB_ALTERNATES_AUTOCORRECTION_APPLIED0x00000004

Indicates that the text range covered by the property is an autocorrection provided by the touch keyboard and applied via the ITfFnReconversion interface.

This value can be used by edit controls or apps, with TKB_ALTERNATES_FOR_AUTOCORRECTION, to prevent the repeated application of an autocorrection.

 

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Msctf.h

IDL

Msctf.idl

See also

TfGuidAtom
ITfCategoryMgr::GetGUID
Using Display Attributes
Mode Bias Values
ITfLMLattice

 

 

Community Additions

ADD
Show:
© 2014 Microsoft