AnalysisHintNode.PrefixText Property

Article
12/12/2007

Gets or sets the prefix text that the InkAnalyzer uses to analyze ink within the current area.

Namespace: System.Windows.Ink
Assembly: IAWinFX (in iawinfx.dll)
XML Namespace: https://schemas.microsoft.com/winfx/2006/xaml/presentation

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);
}

/** @property */
public String get_PrefixText ()

/** @property */
public void set_PrefixText (String value)

public function get PrefixText () : String

public function set PrefixText (value : String)

Not applicable.

Property Value

The prefix text that the InkAnalyzer uses to analyze ink within an 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.AnalysisWarningCode value of SetPrefixSuffixFailed.

Example

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 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.
AnalysisHintNode theAnalysisHint =
    this.theInkAnalyzerWithHint.CreateAnalysisHint();
theAnalysisHint.Location.MakeInfinite();

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

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