AnalysisHintNode.Guide Property

Article
12/12/2007

Gets or sets the recognizer guide that the InkAnalyzer uses to analyze ink within this area.

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink.Analysis (in microsoft.ink.analysis.dll)

Syntax

'Declaration
Public Property Guide As RecognizerGuide
'Usage
Dim instance As AnalysisHintNode
Dim value As RecognizerGuide

value = instance.Guide

instance.Guide = value

public RecognizerGuide Guide { get; set; }

public:
property RecognizerGuide Guide {
    RecognizerGuide get ();
    void set (RecognizerGuide value);
}

/** @property */
public RecognizerGuide get_Guide ()

/** @property */
public void set_Guide (RecognizerGuide value)

public function get Guide () : RecognizerGuide

public function set Guide (value : RecognizerGuide)

Not applicable.

Property Value

The recognizer guide that the InkAnalyzer uses to analyze ink within this area. The default is a RecognizerGuide, where its Rows, Columns, and Midline properties are 0, and its DrawnBox and WritingBox properties are empty rectangles.

Remarks

Note

If the Microsoft.Ink.InkRecognizer that the InkAnalyzer uses for handwriting recognition does not support guides, the InkAnalyzer ignores the guide. For more information about the capabilities that an InkRecognizer supports, see InkRecognizerBase.Capabilities.

All coordinates of the RecognizerGuide are in ink-space coordinates and are relative to the top left corner of the hint. For a global hint, the guide is not translated; it uses the Ink object's coordinate system. For more information about using a guide to improve handwriting recognition, see RecognizerGuide.

During analysis, if the ink recognizer applied to the strokes does not support a guide, the ink analyzer generates an AnalysisWarning with its WarningCode property set to the Microsoft.Ink.AnalysisWarningCode value of GuideNotSupported.

To remove a guide from a hint, call the hint's RemovePropertyData method with propertyDataId set to PropertyGuidsForAnalysisHintsBase.Guide. The guide can also be removed (set to default) by calling ClearGuide method.

Example

This example creates an AnalysisHintNode, theAnalysisHint, for the InkAnalyzer, theInkAnalyzerWithHint, and makes theAnalysisHint a global hint. It then sets the Guide and Name properties on the hint.

' Add a new, global analysis hint to theInkAnalyzerWithHint.
Dim theAnalysisHint As Microsoft.Ink.AnalysisHintNode = _
    Me.theInkAnalyzerWithHint.CreateAnalysisHint()
theAnalysisHint.Location.MakeInfinite()

theAnalysisHint.Guide = New RecognizerGuide(1, 0, _
    Me.theMidlineHeightInHimetric, _
    Rectangle.Inflate(Me.theGuideBoxInHimetric, 50, 50), _
    Me.theGuideBoxInHimetric)
theAnalysisHint.Name = "Recognizer Guide"

// Add a new, global analysis hint to theInkAnalyzerWithHint.
Microsoft.Ink.AnalysisHintNode theAnalysisHint =
    this.theInkAnalyzerWithHint.CreateAnalysisHint();
theAnalysisHint.Location.MakeInfinite();

theAnalysisHint.Guide = new RecognizerGuide(1, 0,
    this.theMidlineHeightInHimetric,
    Rectangle.Inflate(this.theGuideBoxInHimetric, 50, 50),
    this.theGuideBoxInHimetric);
theAnalysisHint.Name = "Recognizer Guide";

Platforms

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0

Share via