SpellCheckerBase.GetCommandsByError(SpellCheckErrorBase) Method

Creates a list of commands, available to the end-user, which depend on the type of misspelling.

Namespace: DevExpress.XtraSpellChecker

Assembly: DevExpress.SpellChecker.v24.1.Core.dll

NuGet Package: DevExpress.SpellChecker.Core

Declaration

C#

public virtual List<SpellCheckerCommand> GetCommandsByError(
    SpellCheckErrorBase error
)

VB.NET

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