SpellChecker.CalcError(Point) Method

Performs a spell check of the word, which occupies the rectangular area to which the specified point belongs.

Namespace: DevExpress.XtraSpellChecker

Assembly: DevExpress.XtraSpellChecker.v18.2.dll

Declaration

C#

public virtual SpellCheckErrorBase CalcError(
    Point p
)

VB.NET

Public Overridable Function CalcError(
    p As Point
) As SpellCheckErrorBase

Parameters

Name	Type	Description
p	Point	A Point that aims the spell checker to test a word located at that point.

Returns

Type	Description
DevExpress.XtraSpellChecker.Rules.SpellCheckErrorBase	A DevExpress.XtraSpellChecker.Rules.SpellCheckErrorBase class instance that contains information on the checked word and found suggestions.

Remarks

Use this method to check the spelling of the word located at arbitrary point within an editor.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CalcError(Point) 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-display-spellchecker-context-menu-for-standard-text-controls-textbox-and-richtextbox-t236002/CS/SpellCheckerMenuExample/Form1.cs#L39

Point position = e.Control.PointToClient(e.Position);
DevExpress.XtraSpellChecker.Rules.SpellCheckErrorBase error = spellChecker1.CalcError(position);
e.Cancel = error == null;

VB.NET

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

Dim position As Point = e.Control.PointToClient(e.Position)
Dim [error] As DevExpress.XtraSpellChecker.Rules.SpellCheckErrorBase = spellChecker1.CalcError(position)
e.Cancel = [error] Is Nothing