IsReadOnly Property

Summary

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

Syntax

C++/CLI

Java

Python

public bool IsReadOnly {get; set;}

public:  
   property bool IsReadOnly 
   { 
      bool get() 
      void set(bool value) 
   }

public boolean isReadOnly() 
public void setReadOnly(boolean value)

IsReadOnly # get and set (LEADDocument)

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 factoryusing LoadFromFile, LoadFromUri or LoadFromStream. 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:

DocumentAnnotations.SetAnnotations
DocumentPage.SetImage
DocumentPage.SetText
DocumentPage.SetSvg
DocumentPage.SetAnnotations
DocumentPage.SetLinks
Pages will be set as a read-only collection. You cannot add, insert or remove pages.