State¶

Gets the state of the document.

Allowed Values¶

Draft
Published
Archived
Deleted

Type¶

1	( `"Draft"` \| `"Published"` \| `"Archived"` \| `"Deleted"` )

Declaration¶

readonly ( `"Draft"` | `"Published"` | `"Archived"` | `"Deleted"` ) myDocument.State

Remarks¶

This property returns one of the following values:

Draft: The document is in draft mode.
Published: The document is published and available.
Archived: The document has been archived.
Deleted: The document has been marked for deletion.

Info

A Published, Deleted, or Archived state makes the document read-only. Except for profile data, all other properties, including the document content, are read-only, and any attempt to modify them will be prohibited.

Getting the current state of a document¶

var state_of_a_document = mydocument.State;