AnalysisHintNode.WordMode Property

Article
12/12/2007

Gets or sets a value indicating whether the InkAnalyzer prioritizes single word results over multiple word results within this area.

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

Syntax

'Declaration
Public Property WordMode As Boolean
'Usage
Dim instance As AnalysisHintNode
Dim value As Boolean

value = instance.WordMode

instance.WordMode = value

public bool WordMode { get; set; }

public:
property bool WordMode {
    bool get ();
    void set (bool value);
}

/** @property */
public boolean get_WordMode ()

/** @property */
public void set_WordMode (boolean value)

public function get WordMode () : boolean

public function set WordMode (value : boolean)

Not applicable.

Property Value

true if the InkAnalyzer prioritizes single word results over multiple word results when analyzing ink within this area; otherwise, false. The default is false.

Remarks

If WordMode is true, the InkAnalyzer may return multiple word results for ink within the hint's area. If CoerceToFactoid is also true, then the InkAnalyzer returns only single word results for ink within the hint's area.

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

Example

This example creates an AnalysisHintNode, theAnalysisHint, for the InkAnalyzer, theInkAnalyzerWithHint, and makes theAnalysisHint a global hint. It then sets the WordMode 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.WordMode = True
theAnalysisHint.Name = "Word Mode"

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

theAnalysisHint.WordMode = true;
theAnalysisHint.Name = "Word Mode";

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