PDFSecurityOptions Class

The PDFSecurityOptions class is used as the type for the SecurityOptions and used to set the security and encryption options to use when creating or updating PDF files.

The following methods of the PDFFile class will use the security options set in .SecurityOptions when updating or created a PDF file:

• Convert
• Distill
• MergeWith
• ExtractPages
• DeletePages
• InsertPagesFrom
• ReplacePagesFrom

If the value of PDFFile.SecurityOptions is null, then the PDFFile will not encrypt the result PDF file.

There are two different ways to protect a PDF file with a password:

• By using a user password set in UserPassword. In this mode, external viewers such as Adobe Acrobat will ask the user for the same password when opening the file for viewing. If the correct password is supplied, then all operations and rights are granted.

• By using an owner password set in OwnerPassword. In this mode, external viewers such as Adobe Acrobat will ask the user for the same password when opening the file for viewing. If the correct password is supplied, the editor will check the various access rights properties to allow or disallow certain operations on the PDF file such as printing or editing.

You cannot use both UserPassword and OwnerPassword in the same PDF file. If both values are set, then the PDFFile object will use OwnerPassword and ignore UserPassword.

This example will re-encrypt a PDF file with an owner password and restrict printing.

• C#
• Visual Basic
• WinRT C#
• WinRT JavaScript
• Silverlight C#
• Silverlight VB

Copy Code  

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.Pdf
Imports Leadtools.WinForms
Imports Leadtools.Svg
Imports Leadtools.ImageProcessing

<TestMethod> _
Public Sub PDFFileSecurityOptionsExample()
   Dim sourceFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf")
   Dim destinationFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "LEAD_EncryptedNoPrint.pdf")
   Dim pdfFile As PDFFile = New PDFFile(sourceFileName)

   ' Set the security options
   pdfFile.SecurityOptions = New PDFSecurityOptions()
   pdfFile.SecurityOptions.UserPassword = "LEAD"
   pdfFile.SecurityOptions.PrintEnabled = False
   pdfFile.SecurityOptions.HighQualityPrintEnabled = False
   pdfFile.SecurityOptions.EncryptionMode = PDFEncryptionMode.RC128Bit

   ' Encrypt the file by saving it to the destination file
   pdfFile.Convert(1, -1, destinationFileName)
End Sub

Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

using Leadtools;
using Leadtools.Codecs;
using Leadtools.Controls;
using Leadtools.Drawing;
using Leadtools.ImageProcessing;
using Leadtools.Pdf;
using Leadtools.Svg;
using Leadtools.WinForms;

[TestMethod]
public void PDFFileSecurityOptionsExample()
{
   string sourceFileName = Path.Combine(LEAD_VARS.ImagesDir, @"Leadtools.pdf");
   string destinationFileName = Path.Combine(LEAD_VARS.ImagesDir, @"LEAD_EncryptedNoPrint.pdf");
   PDFFile pdfFile = new PDFFile(sourceFileName);

   // Set the security options
   pdfFile.SecurityOptions = new PDFSecurityOptions();
   pdfFile.SecurityOptions.UserPassword = "LEAD";
   pdfFile.SecurityOptions.PrintEnabled = false;
   pdfFile.SecurityOptions.HighQualityPrintEnabled = false;
   pdfFile.SecurityOptions.EncryptionMode = PDFEncryptionMode.RC128Bit;

   // Encrypt the file by saving it to the destination file
   pdfFile.Convert(1, -1, destinationFileName);
}

static class LEAD_VARS
{
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

Target Platforms

Reference

PDFSecurityOptions Members
Leadtools.Pdf Namespace