Share via


RecognizerContext.PrefixText Property

Gets or sets the characters that come before the Strokes collection in the RecognizerContext object.

Namespace:  Microsoft.Ink
Assembly:  Microsoft.Ink (in Microsoft.Ink.dll)

Syntax

'Declaration
Public Property PrefixText As String
'Usage
Dim instance As RecognizerContext 
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 characters that come before the Strokes collection in the RecognizerContext object. Must be less than 1k in length.

Remarks

The prefix helps improve recognition results by supplying the recognizer with more context about the handwriting.

Setting the PrefixText property succeeds only if the Strokes property is nulla null reference (Nothing in Visual Basic). You must set the PrefixText property before you attach a Strokes collection to the Strokes property of the RecognizerContext or you must set the Strokes property to nulla null reference (Nothing in Visual Basic) and then set the PrefixText property.

Note

If you use the latter method, you may need to reattach the Strokes collection to the Strokes property of the RecognizerContext object.

Setting the PrefixText to null removes any prefix text from the RecognizerContext object.

The prefix text is ignored unless you have set both the Coerce and WordModeRecognitionModes flags in the RecognitionFlags property.

The SuffixText property gets or sets the characters that come after the strokes in the recognizer context and also helps improve the recognition result.

If your application provides a correction interface when converting ink to text, the application may allow the user to select characters within a word and use the pen to generate replacement characters. Your application can use the PrefixText and SuffixText properties to improve recognition of the new ink.

Examples

This C# example returns the prefix text of the RecognizerContext object, theRecognizerContext.

string thePrefixText = theRecognizerContext.PrefixText;

This Microsoft® Visual Basic® .NET example returns the prefix text of the RecognizerContext object, theRecognizerContext.

Dim thePrefixText As String = theRecognizerContext.PrefixText

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

RecognizerContext Class

RecognizerContext Members

Microsoft.Ink Namespace

RecognizerContext

RecognitionModes

RecognizerContext.Strokes

RecognizerContext.RecognitionFlags

RecognizerContext.SuffixText