SpellChecker.SpellCheckMode Property

Gets or sets the XtraSpellChecker’s operation mode.

Namespace: DevExpress.XtraSpellChecker

Assembly: DevExpress.XtraSpellChecker.v18.2.dll

Declaration

C#

[DefaultValue(SpellCheckMode.OnDemand)]
public SpellCheckMode SpellCheckMode { get; set; }

VB.NET

<DefaultValue(SpellCheckMode.OnDemand)>
Public Property SpellCheckMode As SpellCheckMode

Property Value

Type	Default	Description
SpellCheckMode	**OnDemand**	A SpellCheckMode enumeration member.

Available values:

Name	Description
OnDemand	Starts spelling check and invokes the spelling form for making corrections.
AsYouType	Starts spelling check when you finish typing the word or move the cursor after changing it.This operation mode underlines the misspelled word and allows you to select a suggestion from the context menu, invoked by right-clicking the word.

Remarks

Use this property to switch to the spell-as-you-type operation mode and back to the simple spelling check. The spell-as-you-type mode underlines the misspelled word and allows you to select a suggestion from the context menu, invoked by right-clicking the word.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SpellCheckMode property.

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#

how-to-integrate-spellchecker-menu-items-into-the-xtrarichedit-context-menu-e1758/CS/RichEditPopupMenu/Form1.cs#L52

{
    if (spellChecker1.SpellCheckMode == SpellCheckMode.OnDemand)
    {

how-to-check-spelling-in-different-controls-e4132/CS/Form1.cs#L40

    spellChecker1.Culture = openOfficeDictionaryEnglish.Culture;
    spellChecker1.SpellCheckMode = SpellCheckMode.AsYouType;
}

how-to-create-a-custom-control-with-built-in-spell-checking-capabilities-e1407/CS/CustomMemoEditControl/MyMemoEdit.cs#L38

spellChecker.SetSpellCheckerOptions(control, options);
spellChecker.SpellCheckMode = SpellCheckMode.AsYouType;

how-to-configure-checkasyoutype-mode-for-xtraspellchecker-used-with-xtragrid-e2893/CS/CheckAsYouTypeInXtraGrid/Form1.cs#L39

// Switch to the check-as-you-type mode.
spellChecker1.SpellCheckMode = SpellCheckMode.AsYouType;
//spellChecker1.

how-to-display-spellchecker-context-menu-for-standard-text-controls-textbox-and-richtextbox-t236002/CS/SpellCheckerMenuExample/Form1.cs#L24

{
    spellChecker1.SpellCheckMode = SpellCheckMode.AsYouType;
    spellChecker1.ParentContainer = this;

VB.NET

how-to-integrate-spellchecker-menu-items-into-the-xtrarichedit-context-menu-e1758/VB/RichEditPopupMenu/Form1.vb#L53

ByVal e As DevExpress.XtraRichEdit.PopupMenuShowingEventArgs)
    If spellChecker1.SpellCheckMode = SpellCheckMode.OnDemand Then
        Dim pos As DocumentPosition = richEditControl1.Document.CaretPosition

how-to-check-spelling-in-different-controls-e4132/VB/Form1.vb#L42

    spellChecker1.Culture = openOfficeDictionaryEnglish.Culture
    spellChecker1.SpellCheckMode = SpellCheckMode.AsYouType
End Sub

how-to-create-a-custom-control-with-built-in-spell-checking-capabilities-e1407/VB/CustomMemoEditControl/MyMemoEdit.vb#L40

spellChecker.SetSpellCheckerOptions(control, options)
spellChecker.SpellCheckMode = SpellCheckMode.AsYouType

how-to-configure-checkasyoutype-mode-for-xtraspellchecker-used-with-xtragrid-e2893/VB/CheckAsYouTypeInXtraGrid/Form1.vb#L38

' Switch to the check-as-you-type mode.
spellChecker1.SpellCheckMode = SpellCheckMode.AsYouType
'spellChecker1.

how-to-display-spellchecker-context-menu-for-standard-text-controls-textbox-and-richtextbox-t236002/VB/SpellCheckerMenuExample/Form1.vb#L22

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
    spellChecker1.SpellCheckMode = SpellCheckMode.AsYouType
    spellChecker1.ParentContainer = Me