Documentation

Latest WorkflowsDocumentationJavaScript APIJavaScript methodsEvents

editor.getReadOnly()

Returns whether the editor is currently read-only. Use it to reflect the editing state in your own UI — for example to show a lock icon, or to decide whether a “save” button should be enabled — and as the current value when toggling the mode.

Syntax

editor.getReadOnly()

Parameters

None.

Returns

A boolean: true when the editor is read-only, false when it is editable.

Behavior notes

  • It reports the current mode only. The value flips when you call setReadOnly(); there is no separate flag to keep in sync.
  • Always a boolean. The result is a real true/false, safe to use directly in conditionals.
  • Pair it with setReadOnly to toggle. Reading the current value and passing its inverse is the standard toggle pattern.

Example usage

Toggle read-only mode from a button, using the current value:

var editor1 = new RichTextEditor("#div_editor1");
document.getElementById("btn_lock").onclick = function () {
    editor1.setReadOnly(!editor1.getReadOnly());
};

Only allow saving when the editor is editable:

if (!editor1.getReadOnly()) {
    save(editor1.getHTMLCode());
}

Related