DocumentProperties Property

Summary

Gets the properties or metadata of this PDF document.

Syntax

C++/CLI

Java

Python

public PDFDocumentProperties DocumentProperties { get; }

public PDFDocumentProperties getDocumentProperties();

public: 
property PDFDocumentProperties^ DocumentProperties { 
   PDFDocumentProperties^ get(); 
}

DocumentProperties # get  (PDFDocument)

Property Value

A PDFDocumentProperties object that contains the properties or metadata of the PDF file associated with this PDFDocument. The default value is null.

Remarks

The properties or metadata such as author, subject and keywords are automatically read from the PDF file when the PDFDocument is constructed.

To update the properties of a PDF file, use the PDFFile.SetDocumentProperties method.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Controls; 
using Leadtools.Pdf; 
using Leadtools.Svg; 
using Leadtools.WinForms; 
 
 
public void PDFDocumentExample() 
{ 
   string pdfFileName = Path.Combine(LEAD_VARS.ImagesDir, @"Leadtools.pdf"); 
 
   // Create a PDF document for file 
   using (PDFDocument document = new PDFDocument(pdfFileName)) 
   { 
 
      // Show the file type and properties 
      Console.WriteLine("File type is : {0}", document.FileType); 
      Console.WriteLine("Contains : {0} pages", document.Pages.Count); 
      Console.WriteLine("----------:"); 
      foreach (PDFDocumentPage page in document.Pages) 
      { 
         Console.WriteLine("Page: {0}, size: {1} by {2} ({3} by {4} inches)", page.PageNumber, page.Width, page.Height, page.WidthInches, page.HeightInches); 
      } 
 
      PDFDocumentProperties props = document.DocumentProperties; 
      Console.WriteLine("Properties:"); 
      Console.WriteLine("----------:"); 
      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); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.BufferedWriter; 
import java.io.Console; 
import java.io.File; 
import java.io.FileWriter; 
import java.io.IOException; 
import java.io.OutputStream; 
import java.io.OutputStreamWriter; 
import java.nio.Buffer; 
import java.nio.file.Files; 
import java.nio.file.Path; 
import java.nio.file.Paths; 
import java.nio.file.StandardOpenOption; 
import java.sql.Date; 
import java.text.SimpleDateFormat; 
import java.time.LocalDateTime; 
import java.util.ArrayList; 
import java.util.List; 
 
import javax.xml.validation.Schema; 
 
import org.apache.lucene.store.Directory; 
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.barcode.*; 
import leadtools.codecs.*; 
import leadtools.pdf.*; 
import leadtools.svg.*; 
 
 
public void pdfDocumentExample() { 
   String LEAD_VARS_ImagesDir = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String pdfFileName = combine(LEAD_VARS_ImagesDir, "Leadtools.pdf"); 
 
   // Create a PDF document for file 
   PDFDocument document = new PDFDocument(pdfFileName); 
 
   // Show the file type and properties 
   System.out.println("File type is : " + document.getFileType()); 
   int numPages = 0; 
   for (PDFDocumentPage page : document.getPages()) { 
      numPages++; 
   } 
   System.out.println("Contains : " + numPages + " pages"); 
   System.out.println("----------:"); 
   for (PDFDocumentPage page : document.getPages()) { 
      System.out.println("Page: " + page.getPageNumber() + ", size: " + page.getWidth() + " by " + page.getHeight() 
            + " (" + page.getWidthInches() + " by " + page.getHeightInches() + " inches)"); 
   } 
 
   PDFDocumentProperties props = document.getDocumentProperties(); 
   System.out.println("Properties:"); 
   System.out.println("----------:"); 
   System.out.println("Title: " + props.getTitle()); 
   System.out.println("Author: " + props.getAuthor()); 
   System.out.println("Subject: " + props.getSubject()); 
   System.out.println("Keywords: " + props.getKeywords()); 
   System.out.println("Creator: " + props.getCreator()); 
   System.out.println("Producer: " + props.getProducer()); 
   System.out.println("Created: " + props.getCreated()); 
   System.out.println("Modified: " + props.getModified()); 
   assertTrue(props != null); 
}

Requirements

Target Platforms

Reference

PDFDocument Class

PDFDocument Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies