An EditableRegion object represents an editable region in a document.

Syntax

EditableRegion

Introduced: X18.

Methods

Method Description
getHighlightColor Gets the highlight color for the editable region.
getHighlightMode Gets a value indicating whether the editable region is highlighted.
getLength Gets the number of characters which belong to the editable region.
getStart Gets the index (one-based) of the first character which belongs to the editable region.
getText Gets the editable region's text.
getUserName Gets the name of the user who can edit the region.
save Saves this editable region in a certain format and sends the result back asynchronously by calling a given callback function.
scrollTo Sets the current input position to the beginning of an editable region and scrolls it into the visible part of the document.
setHighlightColor Sets the highlight color for the editable region.
setHighlightMode Sets a value indicating whether the editable region is highlighted.
setUserName Sets the name of the user who can edit the region.

Further Reading

Learn more about the Javascript: EditableRegion Object in the Text Control Blog: