IsEncrypted Method

Summary

Gets a value that indicate whether a PDF file is encrypted.

Syntax

C++/CLI

Java

Python

public static bool IsEncrypted( 
   string fileName 
)

public static boolean isEncrypted( 
   java.lang.String string 
);

public: 
static bool IsEncrypted(  
   String^ fileName 
)

def IsEncrypted(self,fileName):

Parameters

fileName
The name of the PDF file.

Return Value

true if the PDF file is encrypted; otherwise, it is false.

Remarks

This method checks if the PDF file has been encrypted and protected with a password. If this is the case, then you must create a PDFFile object (or set the Password property) to the correct file before you can use the other methods of this object.

To load PDF files, you generally perform this:

Call GetPDFFileType with pdfTypesOnly set to true and determine whether the return value is not PDFFileType.Unknown meaning a valid PDF file of any version.
Call IsEncrypted to determine whether the file is encrypted (password protected), if so, instruct the user for the password to use with this PDF file.
Finally construct a PDFFile object with the filename and password (if any) and call its methods.

Example

Java

using Leadtools.WinForms; 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Controls; 
using Leadtools.Drawing; 
using Leadtools.ImageProcessing; 
using Leadtools.Pdf; 
using Leadtools.Svg; 
 
 
public void PDFFileEncryptedExample() 
{ 
   string pdfFileName1 = Path.Combine(LEAD_VARS.ImagesDir, @"Leadtools.pdf"); 
   string pdfFileName2 = Path.Combine(LEAD_VARS.ImagesDir, @"Encrypted.pdf"); 
 
   // Create an encrypted version of Leadtools.pdf 
   PDFFile file = new PDFFile(pdfFileName1); 
   file.SecurityOptions = new PDFSecurityOptions(); 
   file.SecurityOptions.UserPassword = "LEAD"; 
   file.Convert(1, -1, pdfFileName2); 
 
   // Now try to open it as a document 
   string password = null; 
 
   if (PDFFile.IsEncrypted(pdfFileName2)) 
   { 
      Console.WriteLine("{0}\nIs encrypted. Enter the password:", pdfFileName2); 
      password = Console.ReadLine(); 
   } 
 
   // If the user entered the correct password (LEAD), you can open the file now 
   try 
   { 
      file = new PDFFile(pdfFileName2, password); 
      file.Load(); 
 
      PDFDocumentProperties props = file.DocumentProperties; 
 
      Console.WriteLine("  Title: {0}", props.Title); 
      Console.WriteLine("  Author: {0}", props.Author); 
      Console.WriteLine("  Subject: {0}", props.Subject); 
      Console.WriteLine("  Keywords: {0}", props.Keywords); 
      Console.WriteLine("  Creator: {0}", props.Creator); 
      Console.WriteLine("  Producer: {0}", props.Producer); 
      Console.WriteLine("  Created: {0}", props.Created); 
      Console.WriteLine("  Modified: {0}", props.Modified); 
      Console.WriteLine("----------:"); 
   } 
   catch (Exception ex) 
   { 
      // Otherwise, you will get an error that the PDF file is corrupted 
      Console.WriteLine(ex.Message); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.ByteArrayInputStream; 
import java.io.File; 
import java.io.FileInputStream; 
import java.io.FileNotFoundException; 
import java.io.FileOutputStream; 
import java.io.FileReader; 
import java.io.IOException; 
import java.io.InputStream; 
import java.nio.file.Files; 
import java.nio.file.Paths; 
import java.nio.file.StandardCopyOption; 
import java.util.ArrayList; 
import java.util.Date; 
import java.util.List; 
import java.util.Scanner; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.pdf.*; 
 
 
public void pdfFileEncryptedExample() { 
 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String pdfFileName1 = combine(LEAD_VARS_IMAGES_DIR, "Leadtools.pdf"); 
   String pdfFileName2 = combine(LEAD_VARS_IMAGES_DIR, "Encrypted.pdf"); 
   String password = "LEADTools"; 
 
   // Create an encrypted version of Leadtools.pdf 
   PDFFile file = new PDFFile(pdfFileName1); 
   file.setSecurityOptions(new PDFSecurityOptions()); 
   file.getSecurityOptions().setUserPassword(password); 
   file.convert(1, -1, pdfFileName2); 
 
   assertTrue(PDFFile.isEncrypted(pdfFileName2)); 
 
   // If the user entered the correct password (LEAD), you can open the file now 
   try { 
      file = new PDFFile(pdfFileName2, password); 
      file.load(); 
 
      PDFDocumentProperties props = file.getDocumentProperties(); 
 
      System.out.printf("  Title: %s%n", props.getTitle()); 
      System.out.printf("  Author: %s%n", props.getAuthor()); 
      System.out.printf("  Subject: %s%n", props.getSubject()); 
      System.out.printf("  Keywords: %s%n", props.getKeywords()); 
      System.out.printf("  Creator: %s%n", props.getCreator()); 
      System.out.printf("  Producer: %s%n", props.getProducer()); 
      System.out.printf("  Created: %s%n", props.getCreated()); 
      System.out.printf("  Modified: %s%n", props.getModified()); 
      System.out.println("----------:"); 
   } catch (Exception ex) { 
      // Otherwise, you will get an error that the PDF file is corrupted 
      System.out.println(ex.getMessage()); 
   } 
}

Requirements

Target Platforms

Reference

PDFFile Class

PDFFile Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies