FileName Property

Summary

Gets or sets the name of the file associated with this PDFFile.

Syntax

C++/CLI

Java

Python

public string FileName { get; set; }

public String getFileName(); 
public void setFileName( 
   java.lang.String string 
);

public: 
property String^ FileName { 
   String^ get(); 
   void set (    String^ ); 
}

FileName # get and set (PDFFile)

Property Value

A System.String that contains the name of the file associated with this PDFFile. The default value is a null reference .

Remarks

The PDFFile object must be associated with an existing PDF file on disk when performing any of the actions using the various methods of the class. You can also set the filename when creating the object using the PDFFile(string fileName) or PDFFile(string fileName, string password) constructors.

When you change the filename of a PDFFile object, all previous data is invalidated and the following properties returned to their default values, as follows:

DocumentProperties will be set to null
Pages collection will be set to null

Some PDF files are encrypted and require a password before they can be used. Encrypted files must have the Password property set to the correct value before using the other properties and methods of the object. Use IsEncrypted to determine whether the PDF file is encrypted and requires a password.

After you set the filename and optional password, call the Load method to populate the DocumentProperties and Pages properties of this PDFFile object with the correct values read from the file.

In certain situation, you may want to associate a PDFFile with a Postscript and not a PDF file (for example, to create a PDFFile object and call its Distill method to convert the Postscript file to PDF).

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