Back to Devexpress

SpellCheckerBase.CheckText(String, Boolean) Method

corelibraries-devexpress-dot-xtraspellchecker-dot-spellcheckerbase-dot-checktext-x28-system-dot-string-system-dot-boolean-x29.md

latest2.6 KB
Original Source

SpellCheckerBase.CheckText(String, Boolean) Method

OBSOLETE

Use the CheckText instead.

Checks the specified text to get a list of erroneous words and suggested corrections.

Namespace : DevExpress.XtraSpellChecker

Assembly : DevExpress.SpellChecker.v25.2.Core.dll

NuGet Package : DevExpress.SpellChecker.Core

Declaration

csharp
[Obsolete("Use the CheckText(string) to check text and the WrongWordRecord.GetSuggestions method to get suggestions instead.")]
public virtual List<WrongWordRecord> CheckText(
    string text,
    bool needSuggestions
)
vb
<Obsolete("Use the CheckText(string) to check text and the WrongWordRecord.GetSuggestions method to get suggestions instead.")>
Public Overridable Function CheckText(
    text As String,
    needSuggestions As Boolean
) As List(Of WrongWordRecord)

Parameters

NameTypeDescription
textString

A string that is the text to be checked.

| | needSuggestions | Boolean |

true to calculate suggestions for a misspelled word; otherwise, false.

|

Returns

TypeDescription
List<WrongWordRecord>

A List<WrongWordRecord> object that is a list of WrongWordRecord items containing wrong words and suggestions.

|

Remarks

You can set the needSuggestion to false to achieve a performance gain because in this case, the method will not search for suggestions.

See Also

SpellCheckerBase Class

SpellCheckerBase Members

DevExpress.XtraSpellChecker Namespace