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.v24.1.dll

NuGet Package: DevExpress.Win.SpellChecker

Declaration

C#

public override List<SpellCheckerCommand> GetCommandsByError(
    SpellCheckErrorBase error
)

VB.NET

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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetCommandsByError(SpellCheckErrorBase) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-spreadsheet-spell-check-cell-text/CS/SpreadsheetSpellchecking/Form1.cs#L39

DevExpress.XtraSpellChecker.Rules.SpellCheckErrorBase error = spellChecker.CalcError(position);
List<SpellCheckerCommand> commands = spellChecker.GetCommandsByError(error);
if (commands == null) {

VB.NET

winforms-spreadsheet-spell-check-cell-text/VB/SpreadsheetSpellchecking/Form1.vb#L44

Dim [error] As DevExpress.XtraSpellChecker.Rules.SpellCheckErrorBase = spellChecker.CalcError(position)
Dim commands As List(Of SpellCheckerCommand) = spellChecker.GetCommandsByError([error])
If commands Is Nothing Then