115. XXE.setReadOnly
Prev | Chapter 6. Commands written in the Java™ programming language | Next

## 115. XXE.setReadOnly

Parameter syntax:

    [ 'true'|'false'|'toggle' ]? [ file_name | URL ]?

Changes the state of specified document from read-only to editable or the other way round.

Unlike command `setReadOnly`, this command also acts on the write lock, if any, of specified document:

- When the state of a locked document is changed from editable to read-only, the lock is automatically removed.

- When the state of a document is changed from read-only to editable (and the user wishes her/his documents to be locked), a lock is automatically added.

Parameters:

true

  Ensures that specified document is in read-only state.

false

  Ensures that specified document is in editable state.

toggle

  Changes the state of specified document from read-only to editable or the other way round. This is the default option.

`file_name` or `URL`

  Specifies document location. By default, applies to the current document.

Returns `null`.

Prev | Up | Next
114. XXE.saveAll | Home | 116. XXE.saveAs