Class SpellChecker

Represents a spell checker component with customizable visual styles and colors.

Inheritance

System.Object

SpellChecker

Implements

IVisualStyle

Namespace: Syncfusion.Text

Assembly: Syncfusion.Shared.Base.dll

Syntax

public class SpellChecker : Component, IVisualStyle

Constructors

SpellChecker()

Initializes a new instance of the SpellChecker class.

Declaration

public SpellChecker()

SpellChecker(IContainer)

Initializes a new instance of the SpellChecker class and adds it to the specified container. Applies the current visual theme if it has changed.

Declaration

public SpellChecker(IContainer container)

Parameters

Type	Name	Description
System.ComponentModel.IContainer	container	The container to which the SpellChecker component is added.

Properties

ChangeAllText

Holds the string of the change all.

Declaration

public string ChangeAllText { get; set; }

Property Value

Type
System.String

CloseReason

Gets/Sets the status of the dialog window

Declaration

public CloseReason CloseReason { get; set; }

Property Value

Type
System.Windows.Forms.CloseReason

CustomDictionaryPath

Gets or Sets a value specifying the path of the custom dictionary.

Declaration

public string CustomDictionaryPath { get; set; }

Property Value

Type
System.String

DictionaryPath

Gets or Sets a value specifying the path of the dictionary.

Declaration

public string DictionaryPath { get; set; }

Property Value

Type
System.String

DictionaryStream

Gets or sets the stream that contains the dictionary.

Declaration

public Stream DictionaryStream { get; set; }

Property Value

Type
System.IO.Stream

ExcludeEmailAddress

Gets or Sets a value specifying whether to ignore email address during spell check.

Declaration

public bool ExcludeEmailAddress { get; set; }

Property Value

Type
System.Boolean

ExcludeFileNames

Gets or Sets a value specifying whether to ignore file names during spell check.

Declaration

public bool ExcludeFileNames { get; set; }

Property Value

Type
System.Boolean

ExcludeHtmlTags

Gets or Sets a value specifying whether to ignore html tags during spell check.

Declaration

public bool ExcludeHtmlTags { get; set; }

Property Value

Type
System.Boolean

ExcludeInternetAddresses

Gets or Sets a value specifying whether to ignore internet address during spell check.

Declaration

public bool ExcludeInternetAddresses { get; set; }

Property Value

Type
System.Boolean

ExcludeRepeatedWords

Gets or Sets a value specifying whether to ignore repeated words during spell check.

Declaration

public bool ExcludeRepeatedWords { get; set; }

Property Value

Type
System.Boolean

ExcludeSpecialSymbols

Gets or Sets a value specifying whether to ignore special symbols during spell check.

Declaration

public bool ExcludeSpecialSymbols { get; set; }

Property Value

Type
System.Boolean

ExcludeWordsInMixedCase

Gets or Sets a value specifying whether to ignore words in mixed case during spell check.

Declaration

public bool ExcludeWordsInMixedCase { get; set; }

Property Value

Type
System.Boolean

ExcludeWordsInUpperCase

Gets or Sets a value specifying whether to ignore words in upper case during spell check.

Declaration

public bool ExcludeWordsInUpperCase { get; set; }

Property Value

Type
System.Boolean

ExcludeWordsWithNumbers

Gets or Sets a value specifying whether to ignore words with number during spell check.

Declaration

public bool ExcludeWordsWithNumbers { get; set; }

Property Value

Type
System.Boolean

IsSpreadsheetLikeSpellChecker

Gets/Sets the value to indendify the type of the SpellChecker.

Declaration

public bool IsSpreadsheetLikeSpellChecker { get; set; }

Property Value

Type
System.Boolean

MaxSuggestions

Gets or Sets a value specifying the number of suggestions to be displayed in the suggestion list.

Declaration

public int MaxSuggestions { get; set; }

Property Value

Type
System.Int32

MetroColor

Gets or sets the Metro color used in the SpellChecker dialogs. Updates the color of associated Metro-style dialogs if they are initialized.

Declaration

public Color MetroColor { get; set; }

Property Value

Type
System.Drawing.Color

MisspelledWords

Holds the list of misspelled words.

Declaration

public ArrayList MisspelledWords { get; }

Property Value

Type
System.Collections.ArrayList

VisualStyle

Gets or sets the visual style of the SpellChecker.

Declaration

public SpellCheckerStyle VisualStyle { get; set; }

Property Value

Type
SpellCheckerStyle

Methods

FindCasing(String)

Finds the casing for the given word.

Declaration

public void FindCasing(string word)

Parameters

Type	Name	Description
System.String	word

ResetChangeAllText()

Reset the ChangeAllText property

Declaration

public void ResetChangeAllText()

ResetIsSpreadsheetLikeSpellChecker()

Serializing the Reset property

Declaration

public void ResetIsSpreadsheetLikeSpellChecker()

SpellCheck(ISpellEditor)

Checks the text of the ISpellEditor for misspellings with Syncfusion.Text.SpellChecker.SpellCheckerDialog.

Declaration

public void SpellCheck(ISpellEditor editor)

Parameters

Type	Name	Description
ISpellEditor	editor	IEditor whose text is to be checked for misspellings.

SpellCheck(String)

Performs the spell check operation.

Declaration

public string SpellCheck(string text)

Parameters

Type	Name	Description
System.String	text

Returns

Type
System.String

Suggest(String)

Generates the word list by deleting a single alphabet and interchanging the adjacent alphabets every time

Declaration

public ArrayList Suggest(string source)

Parameters

Type	Name	Description
System.String	source

Returns

Type
System.Collections.ArrayList

WriteToDictionary(String, String)

Writes the specified word to the dictionary.

Declaration

public void WriteToDictionary(string custDictPath, string word)

Parameters

Type	Name	Description
System.String	custDictPath	Specifies the path of the dictionay file.
System.String	word	Specifies the word to be added to the dictionary.

Events

Error

Raised when there is an exception in the SpellChecker.

Declaration

public event SpellChecker.ExceptionHanlder Error

Event Type

Type
SpellChecker.ExceptionHanlder

Explicit Interface Implementations

IVisualStyle.VisualTheme

Declaration

string IVisualStyle.VisualTheme { get; set; }

Returns

Type
System.String

Implements

IVisualStyle