RecognizerContext.SuffixText Property

Article
12/12/2007

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

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

Syntax

'Declaration
Public Property SuffixText As String
'Usage
Dim instance As RecognizerContext
Dim value As String

value = instance.SuffixText

instance.SuffixText = value

public string SuffixText { get; set; }

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

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

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

public function get SuffixText () : String

public function set SuffixText (value : String)

Not applicable.

Property Value

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

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 a null reference (Nothing in Visual Basic). 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 a null reference (Nothing in Visual Basic) 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 a null reference (Nothing in Visual Basic) removes any suffix text from the recognizer context.

The suffix text is ignored unless you have set both the Coerce and WordModeRecognitionModes 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.

Example

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

string theSuffixText = theRecognizerContext.SuffixText;

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

Dim theSuffixText As String = theRecognizerContext.SuffixText

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

Share via