Class SfSpellChecker

SfSpellChecker control helps to find erroneous spelling in a editor and provides suggestions for it.

Inheritance
System.Object
SfSpellChecker
Implements
System.IDisposable
Namespace: Syncfusion.UI.Xaml.Controls
Assembly: Syncfusion.SfSpellChecker.UWP.dll
Syntax
[ClassReference(IsReviewed = false)]
public class SfSpellChecker : Control, IDisposable

Constructors

SfSpellChecker()

Initializes the instance of SfSpellChecker.

Declaration
[ClassReference(IsReviewed = false)]
public SfSpellChecker()

Fields

CustomDictionaryPathProperty

Using a DependencyProperty as the backing store for CustomDictionaryPath. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty CustomDictionaryPathProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

IgnoreAlphaNumericWordsProperty

Using a DependencyProperty as the backing store for IgnoreAlphaNumericWords. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty IgnoreAlphaNumericWordsProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

IgnoreEmailAddressProperty

Using a DependencyProperty as the backing store for IgnoreEmailAddress. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty IgnoreEmailAddressProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

IgnoreHtmlTagsProperty

Using a DependencyProperty as the backing store for IgnoreHtmlTags. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty IgnoreHtmlTagsProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

IgnoreMixedCaseWordsProperty

Using a DependencyProperty as the backing store for IgnoreMixedCaseWords. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty IgnoreMixedCaseWordsProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

IgnoreUpperCaseWordsProperty

Using a DependencyProperty as the backing store for IgnoreUpperCaseWords. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty IgnoreUpperCaseWordsProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

IgnoreUrlProperty

Using a DependencyProperty as the backing store for IgnoreUrl. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty IgnoreUrlProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

Properties

CustomDictionaryPath

gets or sets string value for user dictionary path.

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

IgnoreAlphaNumericWords

Gets or Sets the boolean value to check AlphaNumericWords

Declaration
[ClassReference(IsReviewed = false)]
public bool IgnoreAlphaNumericWords { get; set; }
Property Value
Type Description
System.Boolean

IgnoreEmailAddress

Gets or Sets the boolean value to check Email addresses

Declaration
[ClassReference(IsReviewed = false)]
public bool IgnoreEmailAddress { get; set; }
Property Value
Type Description
System.Boolean

IgnoreHtmlTags

Gets or Sets the boolean value to check HTML tags

Declaration
[ClassReference(IsReviewed = false)]
public bool IgnoreHtmlTags { get; set; }
Property Value
Type Description
System.Boolean

IgnoreMixedCaseWords

Gets or Sets the boolean value to check mixed case words

Declaration
[ClassReference(IsReviewed = false)]
public bool IgnoreMixedCaseWords { get; set; }
Property Value
Type Description
System.Boolean

IgnoreUpperCaseWords

Gets or Sets the boolean value to check upper case words

Declaration
[ClassReference(IsReviewed = false)]
public bool IgnoreUpperCaseWords { get; set; }
Property Value
Type Description
System.Boolean

IgnoreUrl

Gets or Sets the boolean value to check URLs.

Declaration
[ClassReference(IsReviewed = false)]
public bool IgnoreUrl { get; set; }
Property Value
Type Description
System.Boolean

Methods

Dispose()

Disposes the instance of SfSpellChecker

Declaration
public void Dispose()

GetAnagrams(String)

Returns the anagrams for error word

Declaration
[ClassReference(IsReviewed = false)]
public List<string> GetAnagrams(string word)
Parameters
Type Name Description
System.String word
Returns
Type Description
System.Collections.Generic.List<System.String>

GetPhoneticWords(String)

Returns the phonetic suggestions for error word in medium accuracy

Declaration
[ClassReference(IsReviewed = false)]
public List<string> GetPhoneticWords(string word)
Parameters
Type Name Description
System.String word
Returns
Type Description
System.Collections.Generic.List<System.String>

GetPhoneticWords(String, AccuracyLevels)

Declaration
[ClassReference(IsReviewed = false)]
public List<string> GetPhoneticWords(string word, AccuracyLevels accuracy)
Parameters
Type Name Description
System.String word
AccuracyLevels accuracy
Returns
Type Description
System.Collections.Generic.List<System.String>

GetSuggestions(String)

Returns the suggestions for error word

Declaration
[ClassReference(IsReviewed = false)]
public Dictionary<string, List<string>> GetSuggestions(string word)
Parameters
Type Name Description
System.String word
Returns
Type Description
System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

HasError(String)

Checks whether the word exists in dictionary

Declaration
[ClassReference(IsReviewed = false)]
public bool HasError(string word)
Parameters
Type Name Description
System.String word
Returns
Type Description
System.Boolean

PerformSpellCheckUsingContextMenu(IEditorProperties)

Perform spell checking with ContextMenu in the editor control.

Declaration
[ClassReference(IsReviewed = false)]
public void PerformSpellCheckUsingContextMenu(IEditorProperties editor)
Parameters
Type Name Description
IEditorProperties editor

PerformSpellCheckUsingDialog(IEditorProperties)

Perform spell checking with dialog window in the editor control.

Declaration
[ClassReference(IsReviewed = false)]
public void PerformSpellCheckUsingDialog(IEditorProperties editor)
Parameters
Type Name Description
IEditorProperties editor

Events

SpellCheckCompleted

Event which is handled after spell check operations are completed

Declaration
public event EventHandler SpellCheckCompleted
Event Type
Type Description
System.EventHandler

Implements

System.IDisposable

Extension Methods