Class SpellCheckerAdv

Class for SpellCheckerAdv which is derived from Component.

Inheritance
System.Object
BaseComponent
SpellCheckerAdv
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class SpellCheckerAdv : BaseComponent, IThemeProvider, IVisualStyle, IDisposable

Constructors

SpellCheckerAdv()

Initializes the new instance for SpellCheckerAdv class.

Declaration
public SpellCheckerAdv()

Properties

ChangeAllText

Holds the string of the change all.

Declaration
public string ChangeAllText { get; set; }
Property Value
Type
System.String

CloseReason

Gets or sets the status of the dialog window

Declaration
public CloseReason CloseReason { get; set; }
Property Value
Type
System.Windows.Forms.CloseReason

Culture

Gets or Sets the culture to be loaded.

Declaration
public CultureInfo Culture { get; set; }
Property Value
Type
System.Globalization.CultureInfo

CustomDictionaryPath

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

Declaration
public string CustomDictionaryPath { get; set; }
Property Value
Type
System.String

Dictionaries

Gets or sets the dictionary to be added in the DictionaryCollection.

Declaration
public DictionaryCollection Dictionaries { get; set; }
Property Value
Type
DictionaryCollection

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

IgnoreAlphaNumericWords

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

Declaration
public bool IgnoreAlphaNumericWords { get; set; }
Property Value
Type
System.Boolean

IgnoreEmailAddress

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

Declaration
public bool IgnoreEmailAddress { get; set; }
Property Value
Type
System.Boolean

IgnoreFileNames

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

Declaration
public bool IgnoreFileNames { get; set; }
Property Value
Type
System.Boolean

IgnoreHtmlTags

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

Declaration
public bool IgnoreHtmlTags { get; set; }
Property Value
Type
System.Boolean

IgnoreMixedCaseWords

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

Declaration
public bool IgnoreMixedCaseWords { get; set; }
Property Value
Type
System.Boolean

IgnoreRepeatedWords

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

Declaration
public bool IgnoreRepeatedWords { get; set; }
Property Value
Type
System.Boolean

IgnoreSpecialSymbols

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

Declaration
public bool IgnoreSpecialSymbols { get; set; }
Property Value
Type
System.Boolean

IgnoreUpperCaseWords

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

Declaration
public bool IgnoreUpperCaseWords { get; set; }
Property Value
Type
System.Boolean

IgnoreUrl

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

Declaration
public bool IgnoreUrl { get; set; }
Property Value
Type
System.Boolean

IsSpreadsheetLikeSpellChecker

Gets/Sets the value to indentify the type of the SpellCheckerAdv.

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 MetroColor property.

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

ThemeStyle

Gets or sets the GroupViewVisualStyle value used to customize the appearance of the GroupView.

Declaration
public SpellCheckerAdvVisualStyle ThemeStyle { get; set; }
Property Value
Type
SpellCheckerAdvVisualStyle
Remarks

This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

VisualStyle

Gets or sets the VisualStyle of the SpellCheckerAdv

Declaration
public SpellCheckerAdvStyle VisualStyle { get; set; }
Property Value
Type
SpellCheckerAdvStyle

Methods

GetAnagrams(String)

Returns the suggestion list by interchanging the letters of the error word.

Declaration
public List<string> GetAnagrams(string word)
Parameters
Type Name Description
System.String word
Returns
Type
System.Collections.Generic.List<System.String>

GetControlName(String)

Helps to apply the ControlName settings for SpellCheckerAdv.

Declaration
public override string GetControlName(string controlName)
Parameters
Type Name Description
System.String controlName
Returns
Type
System.String
Overrides

GetPhoneticWords(String)

Returns the List of suggestion using the same sound of the word.

Declaration
public List<string> GetPhoneticWords(string word)
Parameters
Type Name Description
System.String word

wrong word
Returns
Type Description
System.Collections.Generic.List<System.String>

List of suggestion

GetPhoneticWords(String, AccuracyLevels)

Returns the phonetic suggestions for error word in specified accuracy

Declaration
public List<string> GetPhoneticWords(string word, AccuracyLevels accuracy)
Parameters
Type Name Description
System.String word
AccuracyLevels accuracy
Returns
Type
System.Collections.Generic.List<System.String>

GetSuggestions(String)

Gets the suggestion list for the given wrong word.

Declaration
public Dictionary<string, List<string>> GetSuggestions(string word)
Parameters
Type Name Description
System.String word

Error word
Returns
Type Description
System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

Dictionary with suggestion

HasError(String)

Checks whether the word is in Dictionary or not.

Declaration
public bool HasError(string word)
Parameters
Type Name Description
System.String word

Word which is need to be check with Dictionary
Returns
Type Description
System.Boolean

True when the word is not in the Dictionary

OnThemeNameChanged(String)

Helps to apply the ThemeName settings for the GroupView.

Declaration
public override void OnThemeNameChanged(string themeName)
Parameters
Type Name Description
System.String themeName

ThemeName
Overrides

PerformSpellCheckForControl(ISpellCheckerAdvEditorTools)

Performs Spell check for loaded TextEditor control.

Declaration
public void PerformSpellCheckForControl(ISpellCheckerAdvEditorTools editor)
Parameters
Type Name Description
ISpellCheckerAdvEditorTools editor

ISpellCheckerAdvEditorTools

RaiseCancelButtonClick(EventArgs)

Raises the CancelButtonClicked event.

Declaration
protected virtual void RaiseCancelButtonClick(EventArgs args)
Parameters
Type Name Description
System.EventArgs args

The System.EventArgs instance containing the event data.

SpellCheck(ISpellCheckerAdvEditorTools)

Method to check the spelling of the given Text editior control.

Declaration
public void SpellCheck(ISpellCheckerAdvEditorTools editor)
Parameters
Type Name Description
ISpellCheckerAdvEditorTools editor

ISpellCheckerAdvEditorTools interface

SpellCheck(String)

Performs the spell check operation.

Declaration
public string SpellCheck(string text)
Parameters
Type Name Description
System.String text

wrong word
Returns
Type Description
System.String

string

SpellCheck(String, Int32)

Declaration
public string SpellCheck(string text, int index)
Parameters
Type Name Description
System.String text
System.Int32 index
Returns
Type
System.String

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

CancelButtonClick

Event to notify when Cancel action is performed

Declaration
public event EventHandler CancelButtonClick
Event Type
Type
System.EventHandler

Error

Raised when there is an exception in the SpellCheckerAdv.

Declaration
public event SpellCheckerAdv.ExceptionHanlder Error
Event Type
Type
SpellCheckerAdv.ExceptionHanlder

SpellCheckCompleted

Occurs when the spell check operations are completed.

Declaration
public event EventHandler<SpellCheckCompletedEventArgs> SpellCheckCompleted
Event Type
Type
System.EventHandler<SpellCheckCompletedEventArgs>

Implements

System.IDisposable