←Select platform

Convert Method

Summary

Converts the file associated with the PDFFile object to a different version using optional document properties and security options.

Syntax

C#
VB
C++
public void Convert( 
   int firstPageNumber, 
   int lastPageNumber, 
   string destinationFileName 
) 

Public Sub Convert( _ 
   ByVal firstPageNumber As Integer, _ 
   ByVal lastPageNumber As Integer, _ 
   ByVal destinationFileName As String _ 
)  

public: 
void Convert(  
   int firstPageNumber, 
   int lastPageNumber, 
   String^ destinationFileName 
)  

Parameters

firstPageNumber
The 1-based number of the first page to be converted. It must be a value greater than or equal to 1.

lastPageNumber
The 1-based number of the last page to be converted. It must be a value greater than or equal to firstPageNumber, and less than or equal to the total number of pages in the file. Use the special value of -1 to represent "last page in the file".

destinationFileName
Name of the destination PDF file to be created. If the value of this parameter is null then 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 set the filename and optional password directly into the FileName and Password properties. You do not need to call Load before using this method.

This method can be used to work on all or portion of the pages in a PDF file. To use all the pages of a document, pass 1 and -1 for firstPageNumber and lastPageNumber.

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

  • SecurityOptions. If the value of this property is not null, then the destination file will be encrypted using the properties of this property. If the value of this property is null, the result file will not be encrypted.

  • CompatibilityLevel. The version of the generated PDF file

Example

This example will convert a PDF file to 1.5 and save it with new properties.

C#
VB
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Controls; 
using Leadtools.Drawing; 
using Leadtools.ImageProcessing; 
using Leadtools.Pdf; 
using Leadtools.Svg; 
using Leadtools.WinForms; 
 
public void PDFFileConvertExample() 
{ 
   string sourceFileName = Path.Combine(LEAD_VARS.ImagesDir, @"Leadtools.pdf"); 
   string destinationFileName = Path.Combine(LEAD_VARS.ImagesDir, @"LEAD_15.pdf"); 
 
   PDFFile pdfFile = new PDFFile(sourceFileName); 
   pdfFile.DocumentProperties = new PDFDocumentProperties(); 
   PDFDocumentProperties properties = pdfFile.DocumentProperties; 
   properties.Author = "Me"; 
   properties.Creator = "My Application"; 
   properties.Title = "My Document"; 
   properties.Producer = "LEAD"; 
   properties.Subject = "My Subject"; 
   properties.Keywords = "Keyword1 Keyword2"; 
   properties.Created = DateTime.Now; 
   properties.Modified = DateTime.Now; 
 
   pdfFile.CompatibilityLevel = PDFCompatibilityLevel.PDF15; 
 
   pdfFile.Convert(1, -1, destinationFileName); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
} 

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Pdf 
Imports Leadtools.WinForms 
Imports Leadtools.Svg 
Imports Leadtools.ImageProcessing 
 
Public Sub PDFFileConvertExample() 
   Dim sourceFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf") 
   Dim destinationFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "LEAD_15.pdf") 
 
   Dim pdfFile As PDFFile = New PDFFile(sourceFileName) 
   pdfFile.DocumentProperties = New PDFDocumentProperties() 
   Dim properties As PDFDocumentProperties = pdfFile.DocumentProperties 
   properties.Author = "Me" 
   properties.Creator = "My Application" 
   properties.Title = "My Document" 
   properties.Producer = "LEAD" 
   properties.Subject = "My Subject" 
   properties.Keywords = "Keyword1 Keyword2" 
   properties.Created = DateTime.Now 
   properties.Modified = DateTime.Now 
 
   pdfFile.CompatibilityLevel = PDFCompatibilityLevel.PDF15 
 
   pdfFile.Convert(1, -1, destinationFileName) 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class 

Requirements

Target Platforms

See Also

Reference

PDFFile Class

PDFFile Members

Help Version 20.0.2018.6.20
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Pdf Assembly