isReadOnly Property

Summary

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

Syntax

JavaScript Syntax

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

TypeScript Syntax

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 Document 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:

SetAnnotations
SetAnnotations
DocumentPages will be set as a read-only collection. You cannot add, insert or remove pages.

The user can set the value of IsReadOnly to false temporarily when modifying a document and re-set the value when done.

Requirements

Target Platforms

Reference

Document Class

Document Members

Leadtools.Documents Namespace

Help Version 19.0.2017.10.27