ASP.NET 3.5 and above only

Obout.Ajax.UI Controls - Spell Checker - Client side

Obout.Ajax.UI.SpellChecker.SpellCheckBehavior class

 Inheritance Hierarchy

It is a client-side representation of the server-side Obout.Ajax.UI.SpellChecker.SpellCheckExtender class.
Note Note
To get or set property values for client API properties, you must call property accessor methods that are named with the get_ and set_ prefixes. For example, to get or set a value for a property such as leftMarker, you call the get_leftMarker or set_leftMarker methods:
var spellCheckerObject = $find("<%= spellChecker1.ClientID %>");
var _leftMarker = spellCheckerObject.get_leftMarker();
...
spellCheckerObject.set_leftMarker("[[");

Properties

Name Description
propertybutton object. Gets or sets the DOM element to initiate spell checking when clicked.
propertycurrentElement object. Gets the DOM element currently is being spell checked.
propertyelements object. Gets an array of the DOM elements that the Behavior is associated with (target elements).
propertyglobalCheck boolean. Gets or sets a value indicating whether to open one global popup for all targets.
propertyid string. Gets the generated identifier that consists of the ID of the associated Sys.UI.DomElement object , the "$" character, and the name value of the Behavior object. (Inherited from Sys.UI.Behavior.)
propertyleftMarker string. Gets or sets the left marker for wrapping the checking word in the target control.
Default "<=".
propertypopupHolder object. Gets the associated Popup Holder object.
propertypopupHolderID string. Gets the associated Popup Holder object ID.
propertyrelatedPopup object. Gets the related popup object.
It returns an object of type Obout.Ajax.UI.HTMLEditor.Popups.SpellCheckPopup or null if the popup is not loaded yet.
propertyrelatedPopupClassName string. Gets the related popup object's type name.
It always returns a string "Obout.Ajax.UI.HTMLEditor.Popups.SpellCheckPopup".
propertyrightMarker string. Gets or sets the right marker for wrapping the checking word in the target control.
Default "=>".
propertystopOnCancel boolean. Gets or sets a value indicating whether to stop checking in client-side when the popup was canceled on one of the targets.
Default false.

Methods

Name Description
propertyaddTargetElement(element) Adds a new DOM element to the targets (to be spell checked).

Parameter:
element - the DOM element to be added to the targets.

Returns:
true - the DOM element is added successfully.
false - the DOM element is not added (duplicate).
propertydelTargetElement(element) Removes the DOM element from the targets (to be spell checked).

Parameter:
element - the DOM element to be removed.

Returns:
true - the DOM element is removed successfully.
false - the DOM element is not removed (not found).
propertyspellCheck() Initiates spell checking on all target elements.

Example:

var spellCheckerObject = $find("<%= spellChecker1.ClientID %>");
spellCheckerObject.spellCheck();
Note Note
To add or remove handler functions for client API events, you must call methods that are named with the add_ and remove_ prefixes. For example, to add or remove a handler function for an event such as checkFinished, you call the add_checkFinished or remove_checkFinished methods:
function checkFinishedHandler(sender, args) {
    // for all TextBoxes was clicked or emulated 'OK' in SpellChecker popup?
    if (args.get_targetsCount() == args.get_targetsAccepted().length) {
        // yes - force submit
        __doPostBack(sender.get_button().id.replace(/_/, "$"), "");
    }
}
...
var spellCheckerObject = $find("<%= spellChecker1.ClientID %>");
spellCheckerObject.add_checkFinished(checkFinishedHandler);
...
spellCheckerObject.remove_checkFinished(checkFinishedHandler);

Events

Name Description
propertybeforeShown Raised before the spell checker's popup is shown.
Event's argument has type Sys.EventArgs.Empty.
propertycheckFinished Raised when spell checking is finished on all targets.
Event's argument has type Obout.Ajax.UI.SpellChecker.CheckFinishedArgs.

See online example.
propertymoveToTarget Raised when the spell checker moves to some target element.
Event's argument has type Obout.Ajax.UI.SpellChecker.MoveToTargetArgs.
propertyshown Raised after the spell checker's popup is shown.
Event's argument has type Sys.EventArgs.Empty.

Example of the event handler:

function shownHandler(sender, args) {
    // alert the ID of the target element for which the popup is shown
    alert("Current target element's ID: " + sender.get_currentElement().id);
}

"Thank you very much. Really appreciate your diligent and quick follow up in showing us how to "Hide grouping area". Your quick follow up and response to your customer base has reinforced our belief in Obout as a top notch web tools suite for web applications. "

Kaydee Dwarak
Grocers Supply Company

Random testimonial   All testimonials