←Select platform

MergeWith(string[],string) Method

Merges this PDF file with one or more PDF existing files.
public void MergeWith( 
   string[] sourceFileNames, 
   string destinationFileName 
Public Overloads Sub MergeWith( _ 
   ByVal sourceFileNames() As String, _ 
   ByVal destinationFileName As String _ 
public void mergeWith( 
   java.lang.String[] string[,  
   java.lang.String string 
void MergeWith(  
   array<String^>^ sourceFileNames, 
   String^ destinationFileName 


An array of System.String's that contain the names of the source files to merge with this PDFFile. Must not be null and must contain at least one item and a maximum of 100 items.

Name of the destination PDF file to be created. If the value of this parameter is null (Nothing in VB) then the filename set in FileName will be updated.


This method will merge two or more existing PDF files to form a new file containing all the pages from the pre-existing PDF files. The new file will be constructed as follows:

  • The pages of the PDF file associated with this PDFFile object will be first

  • The pages of the first file in the sourceFileNames list will be appended next

  • The pages of the second file in the sourceFileNames list will be appended next

  • And so on for each item in sourceFileNames.

When using the MergeWith method, it is important to ensure that the initialPath property is set to the same directory as the Pdf.Utilities.dll.

All the PDF files must pre-exist on disk and must be valid. The sourceFileNames parameter must not contain any null items.

To use this method, associate this PDFFile object with a valid PDF file and optional password. You can achieve 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 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

If one or more of the files to merge with are encrypted with a password, then use the MergeWith(PDFFile[] sourceFiles, string destinationFileName) version of this method that allow you to pass a list of PDFFile objects instead of just the filenames, and thus, associated each input item with an optional password.


This example will merge a group of PDF files to generate a single document that contain all the pages.

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 PDFFileMergeWithExample() 
   string sourceFileName1 = Path.Combine(LEAD_VARS.ImagesDir, @"File1.pdf"); 
   string sourceFileName2 = Path.Combine(LEAD_VARS.ImagesDir, @"File2.pdf"); 
   string sourceFileName3 = Path.Combine(LEAD_VARS.ImagesDir, @"File3.pdf"); 
   string destinationFileName = Path.Combine(LEAD_VARS.ImagesDir, @"Merged.pdf"); 
   // Merge 1 with (2, 3) and form destination 
   PDFFile pdfFile = new PDFFile(sourceFileName1); 
   pdfFile.MergeWith(new string[] { sourceFileName2, sourceFileName2 }, destinationFileName); 
static class LEAD_VARS 
   public const string ImagesDir = @"C:\LEADTOOLS21\Resources\Images"; 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Pdf 
Imports Leadtools.WinForms 
Imports Leadtools.Svg 
Imports Leadtools.ImageProcessing 
Public Sub PDFFileMergeWithExample() 
   Dim sourceFileName1 As String = Path.Combine(LEAD_VARS.ImagesDir, "File1.pdf") 
   Dim sourceFileName2 As String = Path.Combine(LEAD_VARS.ImagesDir, "File2.pdf") 
   Dim sourceFileName3 As String = Path.Combine(LEAD_VARS.ImagesDir, "File3.pdf") 
   Dim destinationFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Merged.pdf") 
   ' Merge 1 with (2, 3) and form destination 
   Dim pdfFile As PDFFile = New PDFFile(sourceFileName1) 
   pdfFile.MergeWith(New String() {sourceFileName2, sourceFileName2}, destinationFileName) 
End Sub 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\LEADTOOLS21\Resources\Images" 
End Class 

Target Platforms

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

Leadtools.Pdf Assembly