In This Topic ▼

isProtected Property

Summary

Indicates whether to create a protected PDF document.

Syntax

TypeScript

JavaScript

Object.defineProperty(PdfDocumentOptions.prototype, 'isProtected', 
   get: function(), 
   set: function(value) 
)

isProtected: boolean;

Property Value

true to create a protected PDF document; otherwise, false. Default value is false.

Remarks

This is used when creating encrypted PDF documents. PDF documents can be encrypted at two levels: low (40-bit RC4) and high (128-bit RC4). To change the encryption level, use the EncryptionMode property.

PDF documents can be protected (secured) in two different ways, as follows:

Protected against viewing. PDF viewer applications will request a password from the user when the document is opened for viewing. This password is called the user password. To protect a PDF document against viewing, set the IsProtected property to true and the UserPassword property to the password value.
Protected against editing. PDF editor applications will request a password from the user when the document is opened for editing. This password is called the owner password. To protect a PDF document against editing, set the IsProtected property to true and the OwnerPassword property to the password value.

When a PDF document is protected against editing (through the use of an owner password), an encryption level and owner access rights can be granted or denied in the resulting document. The following table lists the PDF access rights supported by the LEADTOOLS Document Writers:

Encryption	Owner Access Right
Low (PdfDocumentOptions.EncryptionMode set to PdfDocumentEncryptionMode.RC40Bit)	Printing (PdfDocumentOptions.PrintEnabled), Copying text (PdfDocumentOptions.CopyEnabled), Editing (PdfDocumentOptions.EditEnabled) and Annotations and comments (PdfDocumentOptions.AnnotationsEnabled).
High (PdfDocumentOptions.EncryptionMode set to PdfDocumentEncryptionMode.RC128Bit)	Adds the following to owner access rights supported by low level encryption: High quality printing (PdfDocumentOptions.HighQualityPrintEnabled) and adding/removing pages PdfDocumentOptions.AssemblyEnabled.

Note that Owner Access Rights (UserPassword and OwnerPassword) have effect only if you set the IsProtected property to true.

Note that IsProtected is not supported when the DocumentType is PdfDocumentType.PdfA.

Requirements

Target Platforms

Reference

PdfDocumentOptions Class

PdfDocumentOptions Members

Leadtools.Document.Writer Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.3