CharacterAutoCompletion Property

  • Article

CharacterAutoCompletion Property

Gets or sets the character Autocomplete mode, which determines when characters or words are recognized.

Declaration

[C++]

[propput] HRESULT put_CharacterAutoCompletionMode ([in]
    InkRecognizerCharacterAutoCompletionMode CharacterAutoCompletionMode);
[propget] HRESULT get_CharacterAutoCompletionMode ([out, retval]
    InkRecognizerCharacterAutoCompletionMode*
    CharacterAutoCompletionMode);

[Microsoft® Visual Basic® 6.0]

Public Property Get CharacterAutoCompletion() _
    As InkRecognizerCharacterAutoCompletionMode
Public Property Let CharacterAutoCompletion( _
    ByVal theCompletionMode As InkRecognizerCharacterAutoCompletionMode)

Property Value

InkRecognizerCharacterAutoCompletionMode The character Autocomplete mode, which determines when characters or words are recognized.

This property is read/write.

Return Value

HRESULT value Description
S_OK Success.
E_INVALIDARG The specified mode is invalid.
E_FAIL You must set the Guide property before using this property.
E_INK_EXCEPTION An exception occurred inside the method.
E_POINTER The parameter is an invalid out pointer.

Remarks

Recognition can occur in Full mode (all strokes have been inputted), Partial mode (partial input in specific order), or Random mode (partial input in random order).

For a list of the character Autocomplete mode values that you can use, see the InkRecognizerCharacterAutoCompletionMode enumeration type.

You cannot turn character Autocomplete off after it is set.

You must set the Guide property before using this property.

Some recognizers do not support character Autocomplete. The InkRecognizerCapabilities enumeration contains flags for features a recognizer can support. You can determine if the recognizer supports character Autocomplete by checking the value of the Capabilities property.

Example

[Visual Basic 6.0]

This Visual Basic 6.0 example sets the character Autocomplete mode of a recognizer context to Random.

theRecognizerContext.CharacterAutoCompletionMode = IRCACM_Random

Applies To