Class SpellCheckerModule

Represents the spell checker module in DocumentEditor.

Inheritance

object

SpellCheckerModule

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.DocumentEditor

Assembly: Syncfusion.Blazor.DocumentEditor.dll

Syntax

public class SpellCheckerModule

Constructors

SpellCheckerModule(SfDocumentEditor)

Initializes a new instance of the SpellCheckerModule class. Default constructor for SpellCheckerModule.

Declaration

public SpellCheckerModule(SfDocumentEditor baseComponent)

Parameters

Type	Name	Description
SfDocumentEditor	baseComponent	An DocumentEdiorComponent instance.

Properties

DocumentEditor

DocumentEdiorComponent instance.

Declaration

protected SfDocumentEditor DocumentEditor { get; set; }

Property Value

Type
SfDocumentEditor

Methods

ClearCacheAsync()

Method to clear cached words for spell check.

Declaration

public Task ClearCacheAsync()

Returns

Type	Description
Task	A Task representing the asynchronous operation.

GetAllowSpellCheckAndSuggestionAsync()

Getter indicates whether suggestion enabled.

Declaration

public Task<bool> GetAllowSpellCheckAndSuggestionAsync()

Returns

Type	Description
Task<bool>	A Task representing the asynchronous operation.

GetEnableOptimizedSpellCheckAsync()

Gets the boolean indicating whether optimized spell check to be performed.

Declaration

public Task<bool> GetEnableOptimizedSpellCheckAsync()

Returns

Type	Description
Task<bool>	A Task representing the asynchronous operation.

GetEnableUserDictionaryAsync()

Gets the boolean indicating whether user-specific dictionaries are enabled.

Declaration

public Task<bool> GetEnableUserDictionaryAsync()

Returns

Type	Description
Task<bool>	A Task representing the asynchronous operation.

GetIgnoreUppercaseAsync()

Gets a value indicating whether words in uppercase should be ignored during spell check.

Declaration

public Task<bool> GetIgnoreUppercaseAsync()

Returns

Type	Description
Task<bool>	A Task<TResult> representing the asynchronous operation, with a result of bool that specifies whether uppercase words are ignored.

GetLanguageIDAsync()

Gets the languageID.

Declaration

public Task<int> GetLanguageIDAsync()

Returns

Type	Description
Task<int>	A Task representing the asynchronous operation.

GetRemoveUnderlineAsync()

Getter indicates whether underline removed for mis-spelled word.

Declaration

public Task<bool> GetRemoveUnderlineAsync()

Returns

Type	Description
Task<bool>	A Task representing the asynchronous operation.

GetUniqueWordsCountAsync()

Gets the spell checked Unique words.

Declaration

public Task<int> GetUniqueWordsCountAsync()

Returns

Type	Description
Task<int>	A Task representing the asynchronous operation.

SetAllowSpellCheckAndSuggestionAsync(bool)

Setter to enable or disable suggestion.

Declaration

public void SetAllowSpellCheckAndSuggestionAsync(bool value)

Parameters

Type	Name	Description
bool	value	Specifies the allow spell check and suggestion.

SetEnableOptimizedSpellCheckAsync(bool)

Sets the boolean indicating whether optimized spell check to be performed.

Declaration

public void SetEnableOptimizedSpellCheckAsync(bool value)

Parameters

Type	Name	Description
bool	value	Specifies the enable optimized spell check.

SetEnableUserDictionaryAsync(bool)

Sets the boolean indicating whether user-specific dictionaries are enabled.

Declaration

public void SetEnableUserDictionaryAsync(bool value)

Parameters

Type	Name	Description
bool	value	Specifies the enable user specific dictionaries.

SetIgnoreUppercaseAsync(bool)

Sets a value indicating whether words in uppercase should be ignored during spell check.

Declaration

public void SetIgnoreUppercaseAsync(bool value)

Parameters

Type	Name	Description
bool	value	If true, uppercase words will be ignored during spell check; otherwise, they will be checked.

SetLanguageIDAsync(int)

Sets the languageID.

Declaration

public void SetLanguageIDAsync(int value)

Parameters

Type	Name	Description
int	value	Specifies the language id.

SetRemoveUnderlineAsync(bool)

Setter to enable or disable underline for mis-spelled word.

Declaration

public void SetRemoveUnderlineAsync(bool value)

Parameters

Type	Name	Description
bool	value	Specifies the remove underline.

SetUniqueWordsCountAsync(int)

Sets the spell checked Unique words.

Declaration

public void SetUniqueWordsCountAsync(int value)

Parameters

Type	Name	Description
int	value	Specifies the unique word count.