UserPassword Property

Gets or sets the user password value to be used in the resulting PDF document.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public string UserPassword {get; set;}

'Declaration
 
Public Property UserPassword As String

'Usage
 
Dim instance As PdfDocumentOptions
Dim value As String
 
instance.UserPassword = value
 
value = instance.UserPassword

public string UserPassword {get; set;}

 get_UserPassword();
 set_UserPassword(value);

public:
property String^ UserPassword {
   String^ get();
   void set (    String^ value);
}

Property Value

A System.String that contains the user password value to be used. To reset the user password, use either an empty string or a null reference (Nothing in Visual Basic)

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: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

PdfDocumentOptions Class
PdfDocumentOptions Members
DocumentWriter Class
Programming with LEADTOOLS Document Writers
Files to be Included with Your Application
Unlocking Special LEAD Features