←Select platform

UserPassword Property

Summary

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

Syntax

Java

Objective-C

WinRT C#

C++

public string UserPassword { get; set; }

Public Property UserPassword As String

public string UserPassword {get; set;}

@property (nonatomic, copy, nullable) NSString *userPassword

public String getUserPassword() 
public void setUserPassword(String userPassword)

 <br/>get_UserPassword();<br/>set_UserPassword(value);<br/>Object.defineProperty('UserPassword');

public: 
property String^ UserPassword { 
   String^ get(); 
   void set (    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.

Remarks

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

The UserPassword property is only used when the Protected 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.

Example

For an example, refer to PdfDocumentOptions.

Requirements

Target Platforms

Reference

PdfDocumentOptions Class

PdfDocumentOptions Members

DocumentWriter Class

Programming with LEADTOOLS Document Writers

Files to be Included with Your Application

Unlocking Special LEAD Features

Help Version 19.0.2017.10.27