SpellChecker.GetCommandsByError(SpellCheckErrorBase) Method

Creates a list of commands, available to the end-user, which depend on the type of misspelling and current spellchecker operation mode.

Namespace: DevExpress.XtraSpellChecker

Assembly: DevExpress.XtraSpellChecker.v20.1.dll

Declaration

public override List<SpellCheckerCommand> GetCommandsByError(
    SpellCheckErrorBase error
)
Public Overrides Function GetCommandsByError(
    error As SpellCheckErrorBase
) As List(Of SpellCheckerCommand)

Parameters

Name Type Description
error SpellCheckErrorBase

A DevExpress.XtraSpellChecker.Rules.SpellCheckErrorBase object, representing a situation when a misspelled word is found.

Returns

Type Description
List<SpellCheckerCommand>

A generic list of SpellCheckerCommand objects.

Remarks

The GetCommandsByError method is used to construct menu commands, depending on the SpellCheckMode, specific to different spelling check failure situations, such as misspelled word with suggestions available, the same with no suggestions, repeated word and so on.

See Also