ISpellChecker.Check(Object, ISpellCheckTextController, Position, Position) Method

Checks the spelling of the text available through the controller interface in the specified range and returns on the first error that occurrs.

Namespace: DevExpress.XtraSpellChecker

Assembly: DevExpress.Data.v18.2.dll

Declaration

C#

ISpellingErrorInfo Check(
    object control,
    ISpellCheckTextController controller,
    Position from,
    Position to
)

VB.NET

Function Check(
    control As Object,
    controller As ISpellCheckTextController,
    from As Position,
    to As Position
) As ISpellingErrorInfo

Parameters

Name	Type	Description
control	Object	An object that is a control to be checked for spelling mistakes.
controller	DevExpress.XtraSpellChecker.Parser.ISpellCheckTextController	An object implementing the DevExpress.XtraSpellChecker.Parser.ISpellCheckTextController interface providing text to check.
from	DevExpress.XtraSpellChecker.Parser.Position	A DevExpress.XtraSpellChecker.Parser.Position object containing information on the position where the check statrs.
to	DevExpress.XtraSpellChecker.Parser.Position	A DevExpress.XtraSpellChecker.Parser.Position object containing information on the position where the check finishes.

Returns

Type	Description
ISpellingErrorInfo	An object with the ISpellingErrorInfo interface providing information on the error type and position.

Remarks

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-switch-on-the-checkasyoutype-mode-in-the-richtextbox-control-e5194

Form1.cs

using System.Reflection;
using System.Windows.Forms;
using DevExpress.XtraSpellChecker;
using DevExpress.XtraSpellChecker.Parser;

namespace SpellCheckerSample {
    public partial class Form1 : Form {
        DevExpress.XtraSpellChecker.Native.RichTextBoxTextController controller;

        public Form1() {
            InitializeComponent();
            richTextBox1.LoadFile(Assembly.GetExecutingAssembly().GetManifestResourceStream("SpellCheckerSample.Data.SpellChecker.rtf"), RichTextBoxStreamType.RichText);
            controller = new DevExpress.XtraSpellChecker.Native.RichTextBoxTextController(richTextBox1);
            FindErrors(new IntPosition(0), new IntPosition(richTextBox1.TextLength));
            richTextBox1.TextChanged += OnTextChanged;
        }

        void FindErrors(Position startPos, Position endPos) {
            Position start = startPos.Clone();
            Position end = endPos.Clone();
            ISpellingErrorInfo errorInfo = null;
            do {
                errorInfo = ((ISpellChecker)spellChecker1).Check(richTextBox1, controller, start, end);
                if (errorInfo != null) {
                    start = errorInfo.WordEndPosition;
                    HighlightText(errorInfo.WordStartPosition, errorInfo.WordEndPosition, Color.Red);
                }
                else
                    HighlightText(start, end, Color.Black);
            } while (errorInfo != null);
        }
        void HighlightText(Position start, Position end, Color color) {
            int cachedSelectionStart = richTextBox1.SelectionStart;
            controller.Select(start, end);
            richTextBox1.SelectionColor = color;

            richTextBox1.SelectionStart = cachedSelectionStart;
            richTextBox1.SelectionLength = 0;
        }
        void OnTextChanged(object sender, System.EventArgs e) {
            Position currentPosition = new IntPosition(richTextBox1.SelectionStart);
            Position start = GetPrevWordPosition(currentPosition);
            Position end = controller.GetNextPosition(currentPosition);
            FindErrors(start, end);
        }
        Position GetPrevWordPosition(Position pos) {
            return controller.GetPrevPosition(controller.GetPrevPosition(pos));
        }
    }
}

Form1.vb

Imports System.Reflection
Imports System.Windows.Forms
Imports DevExpress.XtraSpellChecker
Imports DevExpress.XtraSpellChecker.Parser

Namespace SpellCheckerSample
    Partial Public Class Form1
        Inherits Form
        Private controller As DevExpress.XtraSpellChecker.Native.RichTextBoxTextController

        Public Sub New()
            InitializeComponent()
            richTextBox1.LoadFile(System.Reflection.Assembly.GetExecutingAssembly().GetManifestResourceStream("Data.SpellChecker.rtf"), RichTextBoxStreamType.RichText)
            controller = New DevExpress.XtraSpellChecker.Native.RichTextBoxTextController(richTextBox1)
            FindErrors(New IntPosition(0), New IntPosition(richTextBox1.TextLength))
            AddHandler richTextBox1.TextChanged, AddressOf OnTextChanged
        End Sub

        Private Sub FindErrors(ByVal startPos As Position, ByVal endPos As Position)
            Dim start As Position = startPos.Clone()
            Dim [end] As Position = endPos.Clone()
            Dim errorInfo As ISpellingErrorInfo = Nothing
            Do
                errorInfo = (CType(spellChecker1, ISpellChecker)).Check(richTextBox1, controller, start, [end])
                If errorInfo IsNot Nothing Then
                    start = errorInfo.WordEndPosition
                    HighlightText(errorInfo.WordStartPosition, errorInfo.WordEndPosition, Color.Red)
                Else
                    HighlightText(start, [end], Color.Black)
                End If
            Loop While errorInfo IsNot Nothing
        End Sub
        Private Sub HighlightText(ByVal start As Position, ByVal [end] As Position, ByVal color As Color)
            Dim cachedSelectionStart As Integer = richTextBox1.SelectionStart
            controller.Select(start, [end])
            richTextBox1.SelectionColor = color

            richTextBox1.SelectionStart = cachedSelectionStart
            richTextBox1.SelectionLength = 0
        End Sub
        Private Overloads Sub OnTextChanged(ByVal sender As Object, ByVal e As System.EventArgs)
            Dim currentPosition As Position = New IntPosition(richTextBox1.SelectionStart)
            Dim start As Position = GetPrevWordPosition(currentPosition)
            Dim [end] As Position = controller.GetNextPosition(currentPosition)
            FindErrors(start, [end])
        End Sub
        Private Function GetPrevWordPosition(ByVal pos As Position) As Position
            Return controller.GetPrevPosition(controller.GetPrevPosition(pos))
        End Function
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Check(Object, ISpellCheckTextController, Position, Position) 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#

how-to-switch-on-the-checkasyoutype-mode-in-the-richtextbox-control-e5194/CS/SpellCheckerSample/Form1.cs#L27

do {
    errorInfo = ((ISpellChecker)spellChecker1).Check(richTextBox1, controller, start, end);
    if (errorInfo != null) {

VB.NET

how-to-switch-on-the-checkasyoutype-mode-in-the-richtextbox-control-e5194/VB/SpellCheckerSample/Form1.vb#L29

Do
    errorInfo = (CType(spellChecker1, ISpellChecker)).Check(richTextBox1, controller, start, [end])
    If errorInfo IsNot Nothing Then