RecognizerContext.SuffixText Property

  • Article

RecognizerContext.SuffixText Property

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

Definition

Visual Basic .NET Public Property SuffixText As String
C# public string SuffixText { get; set; }
Managed C++ public: __property String* get_SuffixText();
public: __property void set_SuffixText(String*);

Property Value

System.String. The characters that come after the Strokes collection in the RecognizerContext object. Must be less than 1k.

This property is read/write. This property has no default value.

Exceptions

COMException Leave Site:
ObjectDisposedException Leave Site:

Remarks

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

Setting the SuffixText property succeeds only if the Strokes property is null. You must set the SuffixText property before you attach a Strokes collection to the Strokes property of the RecognizerContext, or you must set the Strokes property to null and then set the SuffixText 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 SuffixText to null removes any suffix text from the recognizer context.

The suffix text is ignored unless you have set both the Coerce and WordMode RecognitionModes flags in the RecognitionFlags property.

The PrefixText property gets or sets the characters that come before the Strokes collection in the RecognizerContext object 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

[C#]

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

string theSuffixText = theRecognizerContext.SuffixText;

[Visual Basic .NET]

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

Dim theSuffixText As String = theRecognizerContext.SuffixText

See Also