SpellChecker.SpellingFormShowing Event

Occurs when the spelling form is about to be displayed.

Namespace: DevExpress.XtraSpellChecker

Assembly: DevExpress.XtraSpellChecker.v18.1.dll

Declaration

C#

public event SpellingFormShowingEventHandler SpellingFormShowing

VB.NET

Public Event SpellingFormShowing As SpellingFormShowingEventHandler

Event Data

The SpellingFormShowing event's data class is SpellingFormShowingEventArgs. The following properties provide information specific to this event:

Property	Description
Handled	Gets or sets a value indicating whether default event actions are required. Inherited from FormShowingEventArgs.
Suggestions	Provides access to the collection of suggested words to be displayed at the spelling form.
Word	Gets a misspelled word for which the spelling form is invoked.

Remarks

Handle this event to customize the spelling form’s layout. The spelling form is displayed for each misspelled word, shows a list of suggestions to the user, and awaits the response.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-the-spelling-and-spelling-options-dialogs-t422124

Form1.cs

private void spellChecker1_SpellingFormShowing(object sender, DevExpress.XtraSpellChecker.SpellingFormShowingEventArgs e)
{
    var spellDialogForm = spellChecker1.FormsManager.SpellCheckForm;

    spellDialogForm.Controls["btnIgnore"].Enabled = false;
    spellDialogForm.Controls["btnIgnoreAll"].Visible = false;
    spellDialogForm.Controls["btnChangeAll"].Visible = false;
    spellDialogForm.Controls.Add(new SimpleButton() { Text = "Custom Button", Size = new Size(100, 25), Location = new Point(10, 150) });
}

Form1.vb

Private Sub spellChecker1_SpellingFormShowing(ByVal sender As Object, ByVal e As DevExpress.XtraSpellChecker.SpellingFormShowingEventArgs) Handles spellChecker1.SpellingFormShowing
    Dim spellDialogForm = spellChecker1.FormsManager.SpellCheckForm

    spellDialogForm.Controls("btnIgnore").Enabled = False
    spellDialogForm.Controls("btnIgnoreAll").Visible = False
    spellDialogForm.Controls("btnChangeAll").Visible = False
    spellDialogForm.Controls.Add(New SimpleButton() With {.Text = "Custom Button", .Size = New Size(100, 25), .Location = New Point(10, 150)})
End Sub

Related GitHub Examples

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

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.

VB.NET

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

Private Sub spellChecker1_SpellingFormShowing(ByVal sender As Object, ByVal e As SpellingFormShowingEventArgs) Handles spellChecker1.SpellingFormShowing
    e.Handled = (_activeControl Is memoExEdit1)

how-to-customize-the-spelling-and-spelling-options-dialogs-t422124/VB/SpellingFormsShowingEvent/Form1.vb#L25

#Region "#SpellingFormShowingEvent"
Private Sub spellChecker1_SpellingFormShowing(ByVal sender As Object, ByVal e As DevExpress.XtraSpellChecker.SpellingFormShowingEventArgs) Handles spellChecker1.SpellingFormShowing
    Dim spellDialogForm = spellChecker1.FormsManager.SpellCheckForm