SpellCheck Operations

28 Jun 201720 minutes to read

Essential SpellCheck provides two ways to perform the spellcheck operation(error correction). They are,

Dialog Mode
Context Menu Mode

Dialog Mode

Description

SpellCheck provides the dialog mode option to perform the following spellcheck operations.

Ignore Once
Ignore All
Change
Change All
Add to Dictionary

Open Dialog Mode

The following code snippet shows how to open the dialog to spell check the content.

HTML

<div ng-controller="spellcheckCtrl">
    <div id="SpellCheck" contenteditable="true" ej-spellcheck e-dictionarysettings="dictionarySettings">
        Facebook is a social networking service headquartered in Menlo Park, California. Its website was launched on February 4, 2004, by Mark Zuckerberg with his Harvard College roommates and fellow students Eduardo, Andrew McCollum,Dustin and Chris Hughes. The fouders had initially limited the websites membrship to Harvard students, but later expanded it to collges in the Boston area, the Ivy League, and Stanford Univrsity. It graually added support for students at various other universities and later to high-school students.
    </div>
</div>

JAVASCRIPT

syncApp.controller('spellcheckCtrl', function ($scope) {
    $scope.dictionarySettings = {
		dictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/CheckWords",
        customDictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/AddToDictionary"
	};
    angular.element(document).ready(function () {        
		var spellObj = $('#SpellCheck').data('ejSpellCheck');
        spellObj.showInDialog();
    });
});

Handling Dialog Actions

To define the specific actions before the dialog window open, the client-side event dialogBeforeOpen can be used as depicted in the below code example.

HTML

<div ng-controller="spellcheckCtrl">
    <div id="SpellCheck" contenteditable="true" ej-spellcheck e-dictionarysettings="dictionarySettings" e-dialogbeforeopen="onDialogBeforeOpen">
        Facebook is a social networking service headquartered in Menlo Park, California. Its website was launched on February 4, 2004, by Mark Zuckerberg with his Harvard College roommates and fellow students Eduardo, Andrew McCollum,Dustin and Chris Hughes. The fouders had initially limited the websites membrship to Harvard students, but later expanded it to collges in the Boston area, the Ivy League, and Stanford Univrsity. It graually added support for students at various other universities and later to high-school students.
    </div>
</div>

JAVASCRIPT

syncApp.controller('spellcheckCtrl', function ($scope) {
    $scope.dictionarySettings = {
		dictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/CheckWords",
        customDictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/AddToDictionary"
	};
    $scope.onDialogBeforeOpen = function(args) {
        if (args.requestType == "dialogBeforeOpen") {
           alert("dialog before open event triggered");
        }
    }
    angular.element(document).ready(function () {        
		var spellObj = $('#SpellCheck').data('ejSpellCheck');
        spellObj.showInDialog();
    });    
});

The client-side event dialogOpen can be used to define the specific actions after the dialog window open as shown in the following code example.

HTML

<div ng-controller="spellcheckCtrl">
    <div id="SpellCheck" contenteditable="true" ej-spellcheck e-dictionarysettings="dictionarySettings" e-dialogopen="onDialogOpen">
        Facebook is a social networking service headquartered in Menlo Park, California. Its website was launched on February 4, 2004, by Mark Zuckerberg with his Harvard College roommates and fellow students Eduardo, Andrew McCollum,Dustin and Chris Hughes. The fouders had initially limited the websites membrship to Harvard students, but later expanded it to collges in the Boston area, the Ivy League, and Stanford Univrsity. It graually added support for students at various other universities and later to high-school students.
    </div>
</div>

JAVASCRIPT

syncApp.controller('spellcheckCtrl', function ($scope) {
    $scope.dictionarySettings = {
		dictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/CheckWords",
        customDictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/AddToDictionary"
	};
    $scope.onDialogOpen = function(args) {
        if (args.requestType == "dialogOpen") {
           alert(args.targetText);
        }
    }
    angular.element(document).ready(function () {        
		var spellObj = $('#SpellCheck').data('ejSpellCheck');
        spellObj.showInDialog();
    });    
});

The following code example used to define some actions after the dialog closing by using the client-side event dialogClose.

HTML

<div ng-controller="spellcheckCtrl">
    <div id="SpellCheck" contenteditable="true" ej-spellcheck e-dictionarysettings="dictionarySettings" e-dialogclose="onDialogClose">
        Facebook is a social networking service headquartered in Menlo Park, California. Its website was launched on February 4, 2004, by Mark Zuckerberg with his Harvard College roommates and fellow students Eduardo, Andrew McCollum,Dustin and Chris Hughes. The fouders had initially limited the websites membrship to Harvard students, but later expanded it to collges in the Boston area, the Ivy League, and Stanford Univrsity. It graually added support for students at various other universities and later to high-school students.
    </div>
</div>

JAVASCRIPT

syncApp.controller('spellcheckCtrl', function ($scope) {
    $scope.dictionarySettings = {
		dictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/CheckWords",
        customDictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/AddToDictionary"
	};
    $scope.onDialogClose = function(args) {
        if (args.requestType == "dialogClose") {
           alert(args.updatedText);
        }
    }
    angular.element(document).ready(function () {        
		var spellObj = $('#SpellCheck').data('ejSpellCheck');
        spellObj.showInDialog();
    });    
});

It is possible to predict the error word details before starting the spellcheck operations through dialog mode by using the client side event start. The below code example describes the above behavior.

HTML

<div ng-controller="spellcheckCtrl">
    <div id="SpellCheck" contenteditable="true" ej-spellcheck e-dictionarysettings="dictionarySettings" e-start="onSpellCheckStart">
        Facebook is a social networking service headquartered in Menlo Park, California. Its website was launched on February 4, 2004, by Mark Zuckerberg with his Harvard College roommates and fellow students Eduardo, Andrew McCollum,Dustin and Chris Hughes. The fouders had initially limited the websites membrship to Harvard students, but later expanded it to collges in the Boston area, the Ivy League, and Stanford Univrsity. It graually added support for students at various other universities and later to high-school students.
    </div>
</div>

JAVASCRIPT

syncApp.controller('spellcheckCtrl', function ($scope) {
    $scope.dictionarySettings = {
		dictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/CheckWords",
        customDictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/AddToDictionary"
	};
    $scope.onSpellCheckStart = function(args) {
        if (args.requestType == "spellCheckDialog") {
           alert(JSON.stringify(args.errorWords));
        }
    }
    angular.element(document).ready(function () {        
		var spellObj = $('#SpellCheck').data('ejSpellCheck');
        spellObj.showInDialog();
    });    
});

You can get the corrected text content details before updating it into target element with the help of the client side event complete as mentioned in the below code example.

HTML

<div ng-controller="spellcheckCtrl">
    <div id="SpellCheck" contenteditable="true" ej-spellcheck e-dictionarysettings="dictionarySettings" e-complete="onSpellCheckComplete">
        Facebook is a social networking service headquartered in Menlo Park, California. Its website was launched on February 4, 2004, by Mark Zuckerberg with his Harvard College roommates and fellow students Eduardo, Andrew McCollum,Dustin and Chris Hughes. The fouders had initially limited the websites membrship to Harvard students, but later expanded it to collges in the Boston area, the Ivy League, and Stanford Univrsity. It graually added support for students at various other universities and later to high-school students.
    </div>
</div>

JAVASCRIPT

syncApp.controller('spellcheckCtrl', function ($scope) {
    $scope.dictionarySettings = {
		dictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/CheckWords",
        customDictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/AddToDictionary"
	};
    $scope.onSpellCheckComplete = function(args) {
        if (args.requestType == "changeErrorWord") {
            alert(args.targetText);
        }
    }
    angular.element(document).ready(function () {        
		var spellObj = $('#SpellCheck').data('ejSpellCheck');
        spellObj.showInDialog();
    });    
});

SpellCheck provides default context menu options to perform the spellcheck operations. It also allows to define additional custom context menu options.

The options that are available under contextMenuSettings are as follows,

**enable** - Enables/disables the context menu option in SpellCheck.
**menuItems** - Contains the options to perform spellcheck operations.

The menu items contains the following options to perform the spellcheck operation.

Ignore All
Add to Dictionary

The following code snippet shows how to enable the context menu settings in SpellCheck and to make use of it with default available options.

HTML

<div ng-controller="spellcheckCtrl">
    <div id="SpellCheck" contenteditable="true" ej-spellcheck e-dictionarysettings="dictionarySettings" e-contextmenusettings-enable="true">
        Facebook is a social networking service headquartered in Menlo Park, California. Its website was launched on February 4, 2004, by Mark Zuckerberg with his Harvard College roommates and fellow students Eduardo, Andrew McCollum,Dustin and Chris Hughes. The fouders had initially limited the websites membrship to Harvard students, but later expanded it to collges in the Boston area, the Ivy League, and Stanford Univrsity. It graually added support for students at various other universities and later to high-school students.
    </div>
</div>

JAVASCRIPT

syncApp.controller('spellcheckCtrl', function ($scope) {
    $scope.dictionarySettings = {
		dictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/CheckWords",
        customDictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/AddToDictionary"
	};
    angular.element(document).ready(function () {        
		var spellObj = $('#SpellCheck').data('ejSpellCheck');
        spellObj.validate();
    });    
});

NOTE

For default menu items, the id must be defined the same as mentioned in the above code example – as we have processed the menus based on this id within our source.

Apart from the default available options, it is also possible to add custom menu options to the context-menu list.

The following code example depicts how to add the custom menu items into the context menu settings.

HTML

<div ng-controller="spellcheckCtrl">
    <div id="SpellCheck" contenteditable="true" ej-spellcheck e-dictionarysettings="dictionarySettings" e-contextmenusettings-enable="true" e-contextmenusettings-menuitems="menuItems">
        Facebook is a social networking service headquartered in Menlo Park, California. Its website was launched on February 4, 2004, by Mark Zuckerberg with his Harvard College roommates and fellow students Eduardo, Andrew McCollum,Dustin and Chris Hughes. The fouders had initially limited the websites membrship to Harvard students, but later expanded it to collges in the Boston area, the Ivy League, and Stanford Univrsity. It graually added support for students at various other universities and later to high-school students.
    </div>
</div>

JAVASCRIPT

syncApp.controller('spellcheckCtrl', function ($scope) {
    $scope.dictionarySettings = {
		dictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/CheckWords",
        customDictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/AddToDictionary"
	};
    $scope.menuItems = [
        { id: "Ignore", text: "IgnoreOnce" },
        { id: "IgnoreAll", text: "Ignore All" },
        { id: "AddToDictionary", text: "Add To Dictionary" }
    ];
    angular.element(document).ready(function () {        
		var spellObj = $('#SpellCheck').data('ejSpellCheck');
        spellObj.validate();
    });    
});

NOTE

The id given for the custom menu items must be unique.

The client-side event contextClick can be used to define specific actions when a click made on the custom menu items. The following code example describes the above behavior.

HTML

<div ng-controller="spellcheckCtrl">
    <div id="SpellCheck" contenteditable="true" ej-spellcheck e-dictionarysettings="dictionarySettings" e-contextmenusettings-enable="true" e-contextmenusettings-menuitems="menuItems" e-contextclick="onCustomMenuClick">
        Facebook is a social networking service headquartered in Menlo Park, California. Its website was launched on February 4, 2004, by Mark Zuckerberg with his Harvard College roommates and fellow students Eduardo, Andrew McCollum,Dustin and Chris Hughes. The fouders had initially limited the websites membrship to Harvard students, but later expanded it to collges in the Boston area, the Ivy League, and Stanford Univrsity. It graually added support for students at various other universities and later to high-school students.
    </div>
</div>

JAVASCRIPT

syncApp.controller('spellcheckCtrl', function ($scope) {
    $scope.dictionarySettings = {
		dictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/CheckWords",
        customDictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/AddToDictionary"
	};
    $scope.menuItems = [
        { id: "Ignore", text: "Ignore Once" },
        { id: "IgnoreAll", text: "Ignore All" },
        { id: "AddToDictionary", text: "Add To Dictionary" }
    ];
    $scope.onCustomMenuClick = function(args){
        if (args.selectedOption == "Ignore") {
            alert("Custom menu clicked");
        }
    }
    angular.element(document).ready(function () {        
		var spellObj = $('#SpellCheck').data('ejSpellCheck');
        spellObj.validate();
    });    
});

It is possible to predict the target (error word) on which the right click is made with the use of the event contextOpen. The below code example shows how to block the display of context menu, when right clicked on the word by setting args.cancel as true.

HTML

<div ng-controller="spellcheckCtrl">
    <div id="SpellCheck" contenteditable="true" ej-spellcheck e-dictionarysettings="dictionarySettings" e-contextmenusettings-enable="true" e-contextmenusettings-menuitems="menuItems" e-contextOpen="onBeforeOpen">
        Facebook is a social networking service headquartered in Menlo Park, California. Its website was launched on February 4, 2004, by Mark Zuckerberg with his Harvard College roommates and fellow students Eduardo, Andrew McCollum,Dustin and Chris Hughes. The fouders had initially limited the websites membrship to Harvard students, but later expanded it to collges in the Boston area, the Ivy League, and Stanford Univrsity. It graually added support for students at various other universities and later to high-school students.
    </div>
</div>

JAVASCRIPT

syncApp.controller('spellcheckCtrl', function ($scope) {
    $scope.dictionarySettings = {
		dictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/CheckWords",
        customDictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/AddToDictionary"
	};
    $scope.onBeforeOpen = function(args){
        if (args.selectedErrorWord == "Facebook") {
            args.cancel=true;
        }
    }
    angular.element(document).ready(function () {        
		var spellObj = $('#SpellCheck').data('ejSpellCheck');
        spellObj.validate();
    });    
});

You can get the current spell check operation arguments details with the client-side event validating. The following code example describes the way to block the ignoreAll operation for the particular word.

HTML

<div ng-controller="spellcheckCtrl">
    <div id="SpellCheck" contenteditable="true" ej-spellcheck e-dictionarysettings="dictionarySettings" e-contextmenusettings-enable="true" e-contextmenusettings-menuitems="menuItems" e-validating="onSpellChecking">
        Facebook is a social networking service headquartered in Menlo Park, California. Its website was launched on February 4, 2004, by Mark Zuckerberg with his Harvard College roommates and fellow students Eduardo, Andrew McCollum,Dustin and Chris Hughes. The fouders had initially limited the websites membrship to Harvard students, but later expanded it to collges in the Boston area, the Ivy League, and Stanford Univrsity. It graually added support for students at various other universities and later to high-school students.
    </div>
</div>

JAVASCRIPT

syncApp.controller('spellcheckCtrl', function ($scope) {
    $scope.dictionarySettings = {
		dictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/CheckWords",
        customDictionaryUrl: "http://js.syncfusion.com/ejServices/api/SpellCheck/AddToDictionary"
	};
    $scope.onSpellChecking = function(args){
        if (args.requestType == "ignoreAll" && args.ignoreWord=="textarea") {
            args.cancel=true;
        }
    }
    angular.element(document).ready(function () {        
		var spellObj = $('#SpellCheck').data('ejSpellCheck');
        spellObj.validate();
    });    
});

SpellCheck Operations

Dialog Mode

Description

Open Dialog Mode

Handling Dialog Actions

Context Menu Mode

Default Menu Options

Custom Menu Options

Handling Menu Actions