Starts spell checking the given string.

Namespace:  C1.Win.C1Spell
Assembly:  C1.Win.C1Spell.2 (in C1.Win.C1Spell.2.dll)

Syntax

C#
public string CheckString(
	string str,
	BadWordDialogEnum dialog,
	bool ignoreWithNumbers,
	bool ignoreInUpperCase,
	bool ignoreInMixedCase
)
Visual Basic (Declaration)
Public Function CheckString ( _
	str As String, _
	dialog As BadWordDialogEnum, _
	ignoreWithNumbers As Boolean, _
	ignoreInUpperCase As Boolean, _
	ignoreInMixedCase As Boolean _
) As String

Parameters

str
Type: System..::.String
String to check.
dialog
Type: C1.Win.C1Spell..::.BadWordDialogEnum
The BadWordDialogEnum object that represents whether the bad-word dialog will be used and the language that should be used to display it.
ignoreWithNumbers
Type: System..::.Boolean
Value that indicates if words containing numbers are ignored during spell checking.
ignoreInUpperCase
Type: System..::.Boolean
Value that indicates if words in all uppercase are ignored during spell checking.
ignoreInMixedCase
Type: System..::.Boolean
Value that indicates if words with uppercase characters after lowercase characters are ignored during spell checking.

Return Value

Checked string.

Remarks

Use the LastSpellError property and the SpellError event to find out the occurred errors.

See Also