SetDocumentProperties Method

Summary

Updates the properties of the file associated with this PDFFile object.

Syntax

C++/CLI

Java

Python

public void SetDocumentProperties( 
   string destinationFileName 
)

	setDocumentProperties(leadtools.pdf.PDFDocumentProperties);

public: 
void SetDocumentProperties(  
   String^ destinationFileName 
)

def SetDocumentProperties(self,destinationFileName):

Parameters

destinationFileName
Name of the destination PDF file to be created. If the value of this parameter is nullthen the filename set in FileName will be updated.

Remarks

To use this method, associate the PDFFile object with a valid PDF file and optional password. Do this by either using the PDFFile(string fileName) or PDFFile(string fileName, string password) constructors or setting the filename and optional password directly by calling the FileName and Password properties. It is not necessary to call Load before using this method.

This method will use the following properties of this PDFFile object:

DocumentProperties. If the value of this property is null, then default properties will be used.

The following properties are not used by this method:

SecurityOptions. To encrypt a PDF file, use the Convert method.
CompatibilityLevel. The version of the PDF to be generated is the same as the original version. To create a PDF file with a different version use Convert or ConvertToPDFA

Example

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"; 
}

Requirements

Target Platforms

Reference

PDFFile Class

PDFFile Members

Download our FREE evaluation

Help Version 22.0.2023.7.10

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies