AnalysisHintNode.PrefixText Property

Article
10/19/2012

Gets or sets the prefix text 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 PrefixText As String
'Usage
Dim instance As AnalysisHintNode 
Dim value As String 

value = instance.PrefixText

instance.PrefixText = value

public string PrefixText { get; set; }

public:
property String^ PrefixText {
    String^ get ();
    void set (String^ value);
}

public function get PrefixText () : String 
public function set PrefixText (value : String)

Property Value

Type: System.String
The prefix text that the InkAnalyzer uses to analyze ink within this area. The default is an empty string ("").

Remarks

In languages that have spaces between words, if the prefix text does not end with a space, the InkAnalyzer analyzes the strokes in the hint as if they were a continuation of the characters of the prefix text.

The prefix and suffix text can be used as part of an interface to help correct user input.

During analysis, if the ink recognizer applied to the strokes does not support prefix or suffix text, the ink analyzer generates an AnalysisWarning with its WarningCode property set to the System.Windows.Ink.AnalysisCore.AnalysisWarningCode value of SetPrefixSuffixFailed.

Examples

This example creates an AnalysisHintNode, theAnalysisHint, for the InkAnalyzer, theInkAnalyzerWithHint, and makes theAnalysisHint a global hint. It then sets the PrefixText, SuffixText, 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.PrefixText = "the "
theAnalysisHint.SuffixText = "ing"
theAnalysisHint.Name = "Prefix and Suffix Text"

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

theAnalysisHint.PrefixText = "the ";
theAnalysisHint.SuffixText = "ing";
theAnalysisHint.Name = "Prefix and Suffix Text";

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

Share via