IInkRecognitionAlternate interface (msinkaut.h)

Represents the possible word matches for segments of ink that are compared to a recognizers dictionary.

Inheritance

The IInkRecognitionAlternate interface inherits from the IUnknown interface. IInkRecognitionAlternate also has these types of members:

Methods

The IInkRecognitionAlternate interface has these methods.

IInkRecognitionAlternate::AlternatesWithConstantPropertyValues Retrieves a IInkRecognitionAlternates collection, which are a division of the IInkRecognitionAlternate object on which this method is called.
IInkRecognitionAlternate::get_Ascender Gets the ascender line for a IInkRecognitionAlternate object that represents a single line of text.
IInkRecognitionAlternate::get_Baseline Gets the baseline for a IInkRecognitionAlternate object that represents a single line of text.
IInkRecognitionAlternate::get_Confidence Gets the level of confidence (strong, intermediate, or poor) that a recognizer has in the recognition of an IInkRecognitionAlternate object or a gesture. (IInkRecognitionAlternate.get_Confidence)
IInkRecognitionAlternate::get_ConfidenceAlternates Gets the collection of alternates in which each alternate in the collection consists of the segments with the same property values.
IInkRecognitionAlternate::get_Descender Gets the descender line for an IInkRecognitionAlternate object that represents a single line of text.
IInkRecognitionAlternate::get_LineAlternates Gets the IInkRecognitionAlternates collection in which each alternate in the collection is on a separate line.
IInkRecognitionAlternate::get_LineNumber Gets the line number of the ink that makes up the alternate.
IInkRecognitionAlternate::get_Midline Gets the midline for a IInkRecognitionAlternate object that represents a single line of text.
IInkRecognitionAlternate::get_String Gets the top string of the alternate.
IInkRecognitionAlternate::get_Strokes Gets the collection of strokes that are contained in an object or used to create an object. (IInkRecognitionAlternate.get_Strokes)
IInkRecognitionAlternate::GetPropertyValue Retrieves the value of a specified property of the alternate.
IInkRecognitionAlternate::GetStrokesFromStrokeRanges Retrieves the smallest InkStrokes collection that contains a known input InkStrokes collection and for which the IInkRecognizer object can provide alternates.
IInkRecognitionAlternate::GetStrokesFromTextRange Retrieves the collection that corresponds to the smallest set of recognition segments that contains a specified character range within the alternate.
IInkRecognitionAlternate::GetTextRangeFromStrokes Retrieves the smallest range of recognized text for which the recognizer can return an alternate that contains a known InkStrokes collection.

Remarks

A recognition segment is a basic ink fragment or unit that the recognizer uses internally to produce a recognition result for a known InkDisp object. The segments are usually determined by spacing and are broken down into the smallest possible ink fragments.

Sometimes the ink may have ambiguous distinctions between segments. These segments are compared to a recognizer's dictionary to determine possible matches (alternates). When the segments are compared, the recognizer creates a list of possible alternates and assigns a confidence level to each one, picking a top choice.

For instance, consider the phrase "how are you". This phrase is probably broken into three segments (depending on the spacing between segments), one for each word.

When each segment is recognized, a RecognitionResult is created. Each result then returns a list of alternates to choose from. For instance, the segment "how" may have alternates like "how", "now", "new", and so on, with "how" being the top alternate. By default, the top alternate is returned for each segment. You can choose to return alternates other than the top alternate.

You can also return alternates that are based on the properties of the alternates, such as the confidence level of the recognition result, the line number on which the alternates appear, and so on. See the RecognitionProperty object for a list of the recognition properties.

Alternates of alternates can also be returned.

Not all recognizers set all of the properties listed above. When an application attempts to access a property that is not set by the recognizer, an argument exception is thrown.

If you define a class that implements this interface, the new class will not interact correctly with the Tablet PC application programming interfaces (APIs).

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

See also

IInkRecognitionAlternates Interface

IInkRecognizer Interface

RecognitionProperty Constants