In This Topic ▼

isReadOnly Property

Summary

Indicates that this document is read-only and cannot be modified.

Syntax

TypeScript

JavaScript

Object.defineProperty(LEADDocument.prototype, 'isReadOnly', 
   get: function(), 
   set: function(value) 
)

isReadOnly: boolean;

Property Value

true if this document is read-only and cannot be modified; otherwise, false. Default value is false.

Remarks

A document is read-only by default (the value of IsReadOnly will be true) when it is first loaded by the factory using LoadFromUri. The value of IsReadOnly will be false when it is created using DocumentFactory.Create.

The value of IsReadOnly will persist when the document is saved and then re-loaded from the cache.

Setting is IsReadOnly to true will turn this document into a read-only version. This a logical-only operation that can be set by user applications for sanity checking, the LEADDocument itself will not behave any differently when any of the methods and properties are accessed except for the following methods which will throw an exception: