SpellChecker.GetCommandsByError(SpellCheckErrorBase) Method

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

Namespace: DevExpress.Xpf.SpellChecker

Assembly: DevExpress.Xpf.SpellChecker.v21.2.dll

Declaration

public override List<SpellCheckerCommand> GetCommandsByError(
    SpellCheckErrorBase error
)

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, dependent on the SpellCheckMode, specific to different spelling check failure situations, such as a misspelled word with suggestions available, the same with no suggestions, repeated word and so on.

See Also