SpellCheckerBase.CheckText(String, Boolean) Method

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

Namespace: DevExpress.XtraSpellChecker

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

Declaration

C#

[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.NET

<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

Name	Type	Description
text	String	A string that is the text to be checked.
needSuggestions	Boolean	true to calculate suggestions for a misspelled word; otherwise, false.

Returns

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

Remarks

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