SpellingExtensions.GetErrorOperationCommands(DependencyObject, Int32) Method

Creates a list of commands available for the misspelled or repeated word at the specified position in the given editor.

Namespace: DevExpress.Xpf.SpellChecker

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

Declaration

C#

public static IEnumerable<SpellCheckerCommand> GetErrorOperationCommands(
    this DependencyObject editor,
    int position
)

VB.NET

<ExtensionAttribute>
Public Shared Function GetErrorOperationCommands(
    editor As DependencyObject,
    position As Integer
) As IEnumerable(Of SpellCheckerCommand)

Parameters

Name	Type	Description
editor	DependencyObject	A target editor.
position	Int32	A position in the editor the misspelled or repeated word occupies.

Returns

Type	Description
IEnumerable<SpellCheckerCommand>	A list of error commands available for the target word.

Remarks

The returned list depends on the type of misspelling and current spellchecker operation mode.

Use the GetSpellCheckError method to invoke a custom context menu for misspelled or repeated words, as shown below:

XAML

<TextBox x:Name="textBox" PreviewMouseRightButtonUp="TextBox_PreviewMouseRightButtonUp">
        <TextBox.ContextMenu>
            <ContextMenu ItemsSource="{Binding Path=MenuItems}"/>
        </TextBox.ContextMenu>
        <dxmvvm:Interaction.Behaviors>
            <dxspch:DXSpellChecker Culture="en-US" CheckAsYouType="True"/>
        </dxmvvm:Interaction.Behaviors>
</TextBox>

C#

void TextBox_PreviewMouseRightButtonUp(object sender, MouseButtonEventArgs e)
{
     MenuItems.Clear();
    var commands = this.textBox.GetErrorOperationCommands(this.textBox.SelectionStart);
    foreach (var command in commands) {
        var menuItem = new MenuItem();
        menuItem.Header = command.Caption;
        menuItem.Click += (s, args) => command.DoCommand();
        menuItem.IsEnabled = command.Enabled;
        MenuItems.Add(menuItem);
    }
    if (MenuItems.Count == 0)
        MenuItems.Add(new MenuItem() { Header = "No Error", IsEnabled = false });
}

VB.NET

Private Sub TextBox_PreviewMouseRightButtonUp(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
  MenuItems.Clear()
  Dim commands = Me.textBox.GetErrorOperationCommands(Me.textBox.SelectionStart)
  For Each command In commands
    Dim menuItem = New MenuItem()
    menuItem.Header = command.Caption
    AddHandler menuItem.Click, Sub(s, args) command.DoCommand()
    menuItem.IsEnabled = command.Enabled
    MenuItems.Add(menuItem)
  Next command
  If MenuItems.Count = 0 Then
    MenuItems.Add(New MenuItem() With {.Header = "No Error", .IsEnabled = False})
  End If