Share via


RecognizerGuide Structure

RecognizerGuide Structure

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

Definition

Visual Basic .NET Public Structure RecognizerGuide
C# public struct RecognizerGuide
Managed C++ public __value struct RecognizerGuide

Members Table

The following table lists the members exposed by the object.

Methods

Method Description
Equals Leave Site Indicates whether this instance and a specified object are equal. Inherited from ValueType Leave Site.
Finalize Leave Site Allows an Object Leave Site to attempt to free resources and perform other cleanup operations before the Object Leave Site is reclaimed by garbage collection. Inherited from Object Leave Site.
GetHashCode Leave Site Returns the hash code for this instance. Inherited from ValueType Leave Site.
GetType Leave Site Gets the Type Leave Site of the current instance. Inherited from Object Leave Site.
MemberwiseClone Leave Site Creates a shallow copy of the current Object Leave Site. Inherited from Object Leave Site.
RecognizerGuide Creates a RecognizerGuide object.
static (Shared in Visual Basic .NET)ReferenceEquals Leave Site Determines whether the specified Object Leave Site instances are the same instance. Inherited from Object Leave Site.
ToString Leave Site Returns the fully qualified type name of this instance. Inherited from ValueType Leave Site.

Properties

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

Remarks

The recognizer guide can consist of rows and columns, and gives the recognizer a better context in which to perform recognition. For example, you can draw horizontal lines on a user's screen, almost like a ruled piece of paper, that show where inking should occur (this type of guide would consist only of rows, and no columns). If a user writes on the lines, instead of some arbitrary space, recognition accuracy improves.

tpcsdkua_recognizerguide_1col.jpg

The following figure shows a recognizer guide with four columns.

tpcsdkua_recognizerguide_4col.jpg

Letters such as "t" and "I" are more easily recognized when a guide is used to give context to the ink.

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.

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.

In addition to drawing lines, or rules, on the screen that show users where to write, it is also possible to 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 Recognizer object.

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

Structure Information

Namespace Microsoft.Ink
Assembly Microsoft.Ink (microsoft.ink.dll)
Strong Name Microsoft.Ink, Version=1.7.4009.0, Culture=neutral, PublicKeyToken=a2870d9cc4d021c8

See Also