Share via


AnalysisHintNode.WordMode Property

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);
}
public function get WordMode () : boolean 
public function set WordMode (value : boolean)

Property Value

Type: System.Boolean
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.

Examples

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 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.0

See Also

Reference

AnalysisHintNode Class

AnalysisHintNode Members

Microsoft.Ink Namespace