InkRecognizerGuide class

Represents the area that the recognizer uses in which ink can be drawn. The area is known as the recognition guide.

InkRecognizerGuide has these types of members:

Interfaces

The InkRecognizerGuide class defines these interfaces.

Interface Description
IInkRecognizerGuide This object implements the IInkRecognizerGuide COM interface.

Properties

The InkRecognizerGuide class has these properties.

Property Access type Description
Columns
Read/write
Gets or sets the number of columns in the guide box.
DrawnBox
Read/write
Gets or sets the box that is physically drawn on the tablet's screen and in which writing takes place.
GuideData
Read/write
Gets or sets guide data for C++ developers.
Midline
Read/write
Gets or sets the midline height. The midline height is distance from the baseline to the midline, of the drawn box.
Rows
Read/write
Gets or sets the number of rows in the guide box.
WritingBox
Read/write
Gets or sets the invisible writing area of the guide box in which writing can actually take place.

Remarks

This object can be instantiated by calling the CoCreateInstance method.

By default, there is no recognizer guide. A default guide has all property values set to 0. You must use the properties of this object to set the guide.

If the application has drawn guidelines on the screen on which the user is expected to write, the application should set the values of the properties of the recognizer guide to inform the recognizer. These properties are for the recognizer's use only. Setting them does not, by itself, draw visual clues on the display. The application or the control draws the visual clues.

The recognizer guide can consist of rows and columns, and these give the recognizer a better context in which to perform recognition. Letters such as "t" and "I" are more easily recognized when a guide is used to give context to the ink. For example, you can draw horizontal lines on a screen, that show where writing should occur (this type of guide would consist only of rows, and no columns). By writing on the lines, instead of some arbitrary space, recognition accuracy improves.

The guide specifies the boundaries of the ink in ink space coordinates.

The DrawnBox property can define a box which is the same size as or smaller than the box defined by the WritingBox property.

The following figure shows the elements of a recognizer guide with two rows and no columns.

illustration showing elements of recognizer guide

In addition to drawing lines on the screen that show users where to write, you can draw cells on the screen in which characters or words are written. This is called boxed input and is useful with some Asian languages. To determine if the recognizer is capable of boxed input, call the Capabilities property of the IInkRecognizer object.

The following figure shows a recognizer guide with four columns.

illustration showing recognizer guide with four columns

Requirements

Requirement Value
Minimum supported client
Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server
None supported
Header
Msinkaut.h (also requires Msinkaut_i.c)
Library
InkObj.dll

See also

IInkRecognizer Interface

InkRecognizerContext Class