←Select platform

PDFFile Class

Summary

PDF file features class.

Syntax

C#
VB
C++
Java
[SerializableAttribute()] 
public class PDFFile 
<SerializableAttribute()> 
Public Class PDFFile  
public class PDFFile 
[SerializableAttribute()] 
public ref class PDFFile  

Remarks

The PDFFile class allows the following actions on Adobe Document Format (PDF) and Postscript (PS) files:

All the methods described above can set the compatibility level (version) of the created or updated PDF using the CompatibilityLevel property, update its properties using the DocumentProperties property or set the security and encryption mode using the SecurityOptions property.

To use most of these properties methods, construct a PDFFile object with the PDF file and optional password before performing the action.

The C# PDF File Demos shipped with LEADTOOLS contain a wizard-style user interface to perform all the above actions on existing PDF and PS files.

You can also use the PDFDocument class to parse a PDF file and extract its objects such as text (without invoking OCR), images, hyperlinks, annotations, form fields, digital signatures, internal links and bookmarks.

Example

This example will show the properties of an existing PDF file, update its properties and then save the file to a new file.

C#
VB
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:\LEADTOOLS22\Resources\Images"; 
} 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Pdf 
Imports Leadtools.WinForms 
Imports Leadtools.Svg 
Imports Leadtools.ImageProcessing 
Imports LeadtoolsPdfExamples.Leadtools.Examples 
 
Public Sub PDFFileExample() 
   Dim sourceFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf") 
   Dim destFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "LEAD_14.pdf") 
 
   ' Load the properties of the file 
   ShowProperties("Source file", sourceFileName) 
 
   ' Update the properties of the file 
   Dim file As PDFFile = 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) 
End Sub 
 
Private Shared Sub ShowProperties(ByVal message As String, ByVal fileName As String) 
   Console.WriteLine(message) 
 
   ' Get the properties of the file 
   Dim file As PDFFile = New PDFFile(fileName) 
   file.Load() 
 
   Dim props As PDFDocumentProperties = 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("----------:") 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\LEADTOOLS22\Resources\Images" 
End Class 

Requirements

Target Platforms

See Also

Help Version 22.0.2021.8.24
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Pdf Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.