PDFDocumentProperties Class

Summary

Contains a PDF document properties or metadata.

Syntax

C++/CLI

Java

Python

[SerializableAttribute()] 
public class PDFDocumentProperties

public class PDFDocumentProperties

[SerializableAttribute()] 
public ref class PDFDocumentProperties

class PDFDocumentProperties:

Remarks

The PDFDocumentProperties class contains the properties or metadata of a PDF document such as the title, author and keywords.

This class is used with the following:

As the type for the PDFFile.DocumentProperties property. This property will be populated when a PDF file is loaded in the object using the PDFFile.Load method
As a parameter to the PDFFile.SetDocumentProperties method that can be used update the properties of an existing PDF file.
As the type for the PDFDocument.DocumentProperties property. This property contains the properties of the PDF document loaded in the PDFDocument object.
The following methods of the PDFFile class will use the PDFFile.DocumentProperties to update the properties of the final PDF file created or updated: PDFFile.Convert, PDFFile.Distill, PDFFile.DeletePages, PDFFile.InsertPagesFrom and PDFFile.ReplacePagesFrom. If the value of PDFFile.DocumentProperties is null, then the PDFFile will use default values of the document properties.

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 PDFFileExample() 
{ 
   string sourceFileName = Path.Combine(LEAD_VARS.ImagesDir, @"Leadtools.pdf"); 
   string destFileName = Path.Combine(LEAD_VARS.ImagesDir, @"LEAD_14.pdf"); 
 
   // Load the properties of the file 
   ShowProperties("Source file", sourceFileName); 
 
   // Update the properties of the file 
   PDFFile file = new PDFFile(sourceFileName); 
   file.DocumentProperties = new PDFDocumentProperties(); 
   file.DocumentProperties.Author = "Me"; 
   file.DocumentProperties.Title = "My title"; 
   file.DocumentProperties.Subject = "My subject"; 
   file.DocumentProperties.Creator = "My application"; 
   file.DocumentProperties.Modified = DateTime.Now; 
   file.SetDocumentProperties(destFileName); 
 
   // Show the properties of the new file 
   ShowProperties("Destination file", destFileName); 
} 
 
private static void ShowProperties(string message, string fileName) 
{ 
   Console.WriteLine(message); 
 
   // Get the properties of the file 
   PDFFile file = new PDFFile(fileName); 
   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("----------:"); 
} 
 
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 pdfFileExample() { 
 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String sourceFileName = combine(LEAD_VARS_IMAGES_DIR, "Leadtools.pdf"); 
   String destFileName = combine(LEAD_VARS_IMAGES_DIR, "LEAD_14.pdf"); 
 
   // Load the properties of the file 
   pdfShowProperties("Source file", sourceFileName); 
 
   // Update the properties of the file 
   PDFFile file = new PDFFile(sourceFileName); 
   PDFDocumentProperties properties = new PDFDocumentProperties(); 
   properties.setAuthor("Me"); 
   properties.setTitle("My title"); 
   properties.setSubject("My subject"); 
   properties.setCreator("My application"); 
   properties.setModified(new Date()); 
   file.setDocumentProperties(properties); 
   file.extractPages(1, file.getPageCount(), destFileName); 
 
   // Show the properties of the new file 
   pdfShowProperties("Destination file", destFileName); 
 
   PDFFile savedFile = new PDFFile(destFileName); 
   savedFile.load(); 
   assertTrue(savedFile.getDocumentProperties().getAuthor().equals("Me")); 
} 
 
private static void pdfShowProperties(String message, String fileName) { 
 
   System.out.println(message); 
 
   // Get the properties of the file 
   PDFFile file = new PDFFile(fileName); 
   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.printf("----------:"); 
 
}

Requirements

Target Platforms

Reference

PDFDocumentProperties Members

Leadtools.Pdf Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies