←Select platform

UserPassword Property

Summary

The user password to use when encrypting a PDF file.

Syntax

C++

public string UserPassword { get; set; }

Public Property UserPassword As String

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

Property Value

A System.String that contain the user password to use when encrypting a PDF file. The default value is null.

Remarks

UserPassword and owner OwnerPassword are not used and will be set to the default value of null when the owner object is PDFDocument.SecurityOptions.

PDF files can be encrypted with two passwords: user (UserPassword) and owner (OwnerPassword).

The UserPassword is used only with viewing the PDF file, so PDF viewers such as Adobe Acrobat will ask for the UserPassword if specified in a PDF and will allow anyone to view the file if a correct value is supplied. To allow anyone to view the PDF file, do not set a value in the UserPassword (leave it as an empty string or null).

The OwnerPassword is used to restrict certain rights on the PDF file when loading into a view such as Adobe Acrobat, these include disabling print (PrintEnabled and HighQualityPrintEnabled), copying text to the clipboard (CopyEnabled), annotations (AnnotationsEnabled) and editing and re-assembling the PDF file (EditEnabled and AssemblyEnabled). When encrypting a PDF file with an OwnerPassword, you can enable or disable any of these rights based on your application needs.

You cannot supply both a user and owner password in the same PDF file. If both passwords are supplied, then the UserPassword is ignored.

Example

For an example, refer to PDFFile.

Requirements

Target Platforms

Reference

PDFSecurityOptions Class

PDFSecurityOptions Members

Help Version 19.0.2017.10.27