userPassword Property


User password value to be used in the resulting PDF document.

Object.defineProperty(PdfDocumentOptions.prototype, 'userPassword', 
   get: function(), 
   set: function(value) 
userPassword: string; 

Property Value

A String that contains the user password value to be used. To reset the user password, use either an empty string or null. Default value is null.


The user password is used by PDF viewers to grant or deny viewing the PDF document. For more information, refer to the IsProtected property.

The UserPassword property is only used when the IsProtected property is set to true.

Important: UserPassword and OwnerPassword will internally be converted to an ASCII string due to the specifications of the PDF format.

Note that UserPassword is not supported when DocumentType is PdfDocumentType.PdfA.


Target Platforms

Help Version 20.0.2020.4.3
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document Assembly