InsertPagesFrom Method

Summary

Inserts one or more pages from an existing PDF file into the file associated with this PDFFile object.

Syntax

C++

public void InsertPagesFrom( 
   int insertPageNumber, 
   PDFFile sourceFile, 
   int firstPageNumber, 
   int lastPageNumber 
)

Public Sub InsertPagesFrom( _ 
   ByVal insertPageNumber As Integer, _ 
   ByVal sourceFile As PDFFile, _ 
   ByVal firstPageNumber As Integer, _ 
   ByVal lastPageNumber As Integer _ 
)

public: 
void InsertPagesFrom(  
   int insertPageNumber, 
   PDFFile^ sourceFile, 
   int firstPageNumber, 
   int lastPageNumber 
)

Parameters

insertPageNumber
The 1-based number of the insertion point in this PDFFile object. Use a value of 0 to insert the new pages at the beginning of the file and -1 to insert the new pages at the end of the file (append).

sourceFile
A PDFFile object associated with an existing PDF file that contain the source file to insert the pages from.

firstPageNumber
The 1-based number of the first page in the source file to be inserted. Must be a value greater than or equal to 1.

lastPageNumber
The 1-based number of the last page in the source file to be inserted. 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".

Remarks

Both files in this PDFFile (the destination) and sourceFile must exist and contain valid PDF files prior to calling this method.

To use this method, associate this PDFFile object and the source PDFFile 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

Example

This example will insert pages from an existing PDF file to a different one in various locations.

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 PDFFileInsertPagesFromExample() 
{ 
   string originalFileName = Path.Combine(LEAD_VARS.ImagesDir, @"Leadtools.pdf"); 
   string sourceFileName = Path.Combine(LEAD_VARS.ImagesDir, @"PDFSegmentation.pdf"); 
 
   string destinationFileName1 = Path.Combine(LEAD_VARS.ImagesDir, @"InsertAtBeginning.pdf"); 
   string destinationFileName2 = Path.Combine(LEAD_VARS.ImagesDir, @"InsertInMiddle.pdf"); 
   string destinationFileName3 = Path.Combine(LEAD_VARS.ImagesDir, @"InsertAtEnd.pdf"); 
 
   // Make a copy of the original file 
   File.Copy(originalFileName, destinationFileName1, true); 
   File.SetAttributes(destinationFileName1, FileAttributes.Normal); 
   File.Copy(originalFileName, destinationFileName2, true); 
   File.SetAttributes(destinationFileName2, FileAttributes.Normal); 
   File.Copy(originalFileName, destinationFileName3, true); 
   File.SetAttributes(destinationFileName3, FileAttributes.Normal); 
 
   // This is the source PDF file to insert into the destination 
   PDFFile sourceFile = new PDFFile(sourceFileName); 
 
   // Insert sourceFileName2 into destinationFileName1 at the beginning 
   PDFFile file = new PDFFile(destinationFileName1); 
   file.InsertPagesFrom(0, sourceFile, 1, -1); 
 
   // Insert sourceFileName2 into destinationFileName2 in the middle 
   file = new PDFFile(destinationFileName2); 
   file.InsertPagesFrom(file.GetPageCount() / 2, sourceFile, 1, -1); 
 
   // Insert sourceFileName2 into destinationFileName3 at the end (append) 
   file = new PDFFile(destinationFileName3); 
   file.InsertPagesFrom(-1, sourceFile, 1, -1); 
} 
 
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 PDFFileInsertPagesFromExample() 
   Dim originalFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf") 
   Dim sourceFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "PDFSegmentation.pdf") 
 
   Dim destinationFileName1 As String = Path.Combine(LEAD_VARS.ImagesDir, "InsertAtBeginning.pdf") 
   Dim destinationFileName2 As String = Path.Combine(LEAD_VARS.ImagesDir, "InsertInMiddle.pdf") 
   Dim destinationFileName3 As String = Path.Combine(LEAD_VARS.ImagesDir, "InsertAtEnd.pdf") 
 
   ' Make a copy of the original file 
   System.IO.File.Copy(originalFileName, destinationFileName1, True) 
   System.IO.File.SetAttributes(destinationFileName1, FileAttributes.Normal) 
   System.IO.File.Copy(originalFileName, destinationFileName2, True) 
   System.IO.File.SetAttributes(destinationFileName2, FileAttributes.Normal) 
   System.IO.File.Copy(originalFileName, destinationFileName3, True) 
   System.IO.File.SetAttributes(destinationFileName3, FileAttributes.Normal) 
 
   ' This is the source PDF file to insert into the destination 
   Dim sourceFile As PDFFile = New PDFFile(sourceFileName) 
 
   ' Insert sourceFileName2 into destinationFileName1 at the beginning 
   Dim file As PDFFile = New PDFFile(destinationFileName1) 
   file.InsertPagesFrom(0, sourceFile, 1, -1) 
 
   ' Insert sourceFileName2 into destinationFileName2 in the middle 
   file = New PDFFile(destinationFileName2) 
   file.InsertPagesFrom(Convert.ToInt32(file.GetPageCount() / 2), sourceFile, 1, -1) 
 
   ' Insert sourceFileName2 into destinationFileName3 at the end (append) 
   file = New PDFFile(destinationFileName3) 
   file.InsertPagesFrom(-1, sourceFile, 1, -1) 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

Reference

PDFFile Class

PDFFile Members

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies